dlls/shlwapi/stopwatch.c

   1 /*
   2  * Stopwatch Functions
   3  *
   4  * Copyright 2004 Jon Griffiths
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  *
  20  * NOTES
  21  * These functions probably never need to be implemented unless we
  22  * A) Rewrite explorer from scratch, and
  23  * B) Want to use a substandard API to tune its performance.
  24  */
  25
  26 #include <stdarg.h>
  27 #include <string.h>
  28 #include <stdlib.h>
  29
  30 #define NONAMELESSUNION
  31
  32 #include "windef.h"
  33 #include "winbase.h"
  34 #include "winreg.h"
  35 #include "winternl.h"
  36 #include "wine/debug.h"
  37
  38 WINE_DEFAULT_DEBUG_CHANNEL(shell);
  39
  40 /*************************************************************************
  41  *      @       [SHLWAPI.241]
  42  *
  43  * Get the current performance monitoring mode.
  44  *
  45  * PARAMS
  46  *  None.
  47  *
  48  * RETURNS
  49  *  The current performance monitoring mode. This is zero if monitoring
  50  *  is disabled (the default).
  51  *
  52  * NOTES
  53  *  If this function returns 0, no further StopWatch functions should be called.
  54  */
  55 DWORD WINAPI StopWatchMode(void)
  56 {
  57   FIXME("() stub!\n");
  58   return 0;
  59 }
  60
  61 /*************************************************************************
  62  *      @       [SHLWAPI.242]
  63  *
  64  * Write captured performance nodes to a log file.
  65  *
  66  * PARAMS
  67  *  None.
  68  *
  69  * RETURNS
  70  *  Nothing.
  71  */
  72 void WINAPI StopWatchFlush(void)
  73 {
  74   FIXME("() stub!\n");
  75 }
  76
  77 /*************************************************************************
  78  *      @       [SHLWAPI.244]
  79  *
  80  * Write a performance event to a log file
  81  *
  82  * PARAMS
  83  *  dwClass     [I] Class of event
  84  *  lpszStr     [I] Text of event to log
  85  *  dwUnknown   [I] Unknown
  86  *  dwMode      [I] Mode flags
  87  *  dwTimeStamp [I] Timestamp
  88  *
  89  * RETURNS
  90  *  Success: ERROR_SUCCESS.
  91  *  Failure: A standard Win32 error code indicating the failure.
  92  */
  93 DWORD WINAPI StopWatchW(DWORD dwClass, LPCWSTR lpszStr, DWORD dwUnknown,
  94                         DWORD dwMode, DWORD dwTimeStamp)
  95 {
  96     FIXME("(%ld,%s,%ld,%ld,%ld) stub!\n", dwClass, debugstr_w(lpszStr),
  97         dwUnknown, dwMode, dwTimeStamp);
  98   return ERROR_SUCCESS;
  99 }
 100
 101 /*************************************************************************
 102  *      @       [SHLWAPI.243]
 103  *
 104  * See StopWatchW.
 105  */
 106 DWORD WINAPI StopWatchA(DWORD dwClass, LPCSTR lpszStr, DWORD dwUnknown,
 107                         DWORD dwMode, DWORD dwTimeStamp)
 108 {   DWORD retval;
 109     UNICODE_STRING szStrW;
 110
 111     if(lpszStr) RtlCreateUnicodeStringFromAsciiz(&szStrW, lpszStr);
 112     else szStrW.Buffer = NULL;
 113
 114     retval = StopWatchW(dwClass, szStrW.Buffer, dwUnknown, dwMode, dwTimeStamp);
 115
 116     RtlFreeUnicodeString(&szStrW);
 117     return retval;
 118 }
 119
 120 /*************************************************************************
 121  *      @       [SHLWAPI.245]
 122  *
 123  * Log a shell frame event.
 124  *
 125  * PARAMS
 126  *  hWnd       [I] Window having the event
 127  *  pvUnknown1 [I] Unknown
 128  *  bUnknown2  [I] Unknown
 129  *  pClassWnd  [I] Window of class to log
 130  *
 131  * RETURNS
 132  *  Nothing.
 133  */
 134 void WINAPI StopWatch_TimerHandler(HWND hWnd, PVOID pvUnknown1, BOOL bUnknown2, HWND *pClassWnd)
 135 {
 136   FIXME("(%p,%p,%d,%p) stub!\n", hWnd, pvUnknown1, bUnknown2 ,pClassWnd);
 137 }
 138
 139 /* FIXME: Parameters for @246:StopWatch_CheckMsg unknown */
 140
 141 /*************************************************************************
 142  *      @       [SHLWAPI.247]
 143  *
 144  * Log the start of an applet.
 145  *
 146  * PARAMS
 147  *  lpszName [I] Name of the applet
 148  *
 149  * RETURNS
 150  *  Nothing.
 151  */
 152 void WINAPI StopWatch_MarkFrameStart(LPCSTR lpszName)
 153 {
 154   FIXME("(%s) stub!\n", debugstr_a(lpszName));
 155 }
 156
 157 /* FIXME: Parameters for @248:StopWatch_MarkSameFrameStart unknown */
 158
 159 /*************************************************************************
 160  *      @       [SHLWAPI.249]
 161  *
 162  * Log a java applet stopping.
 163  *
 164  * PARAMS
 165  *  lpszEvent  [I] Name of the event (applet)
 166  *  hWnd       [I] Window running the applet
 167  *  dwReserved [I] Unused
 168  *
 169  * RETURNS
 170  *  Nothing.
 171  */
 172 void WINAPI StopWatch_MarkJavaStop(LPCWSTR lpszEvent, HWND hWnd, DWORD dwReserved)
 173 {
 174   FIXME("(%s,%p,0x%08lx) stub!\n", debugstr_w(lpszEvent), hWnd, dwReserved);
 175 }
 176
 177 /*************************************************************************
 178  *      @       [SHLWAPI.250]
 179  *
 180  * Read the performance counter.
 181  *
 182  * PARAMS
 183  *  None.
 184  *
 185  * RETURNS
 186  *  The low 32 bits of the current performance counter reading.
 187  */
 188 DWORD WINAPI GetPerfTime(void)
 189 {
 190   static LARGE_INTEGER iCounterFreq = { {0} };
 191   LARGE_INTEGER iCounter;
 192
 193   TRACE("()\n");
 194
 195   if (!iCounterFreq.QuadPart)
 196    QueryPerformanceFrequency(&iCounterFreq);
 197
 198   QueryPerformanceCounter(&iCounter);
 199   iCounter.QuadPart = iCounter.QuadPart * 1000 / iCounterFreq.QuadPart;
 200   return iCounter.u.LowPart;
 201 }
 202
 203 /* FIXME: Parameters for @251:StopWatch_DispatchTime unknown */
 204
 205 /*************************************************************************
 206  *      @       [SHLWAPI.252]
 207  *
 208  * Set an as yet unidentified performance value.
 209  *
 210  * PARAMS
 211  *  dwUnknown [I] Value to set
 212  *
 213  * RETURNS
 214  *  dwUnknown.
 215  */
 216 DWORD WINAPI StopWatch_SetMsgLastLocation(DWORD dwUnknown)
 217 {
 218   FIXME("(%ld) stub!\n", dwUnknown);
 219
 220   return dwUnknown;
 221 }
 222
 223 /* FIXME: Parameters for @253:StopWatchExA, 254:StopWatchExW unknown */