From 75175345ae0c8290ef252d3224f5620a65dc409d Mon Sep 17 00:00:00 2001 From: Matthew Becker Date: Sun, 18 Oct 1998 14:39:06 +0000 Subject: [PATCH] Documentation updates. --- include/main.h | 1 + ole/compobj.c | 4 +++ ole/ifs.c | 65 ++++++++++++++++++++++++++++++++--- ole/ole2disp.c | 14 +++++++- ole/ole2nls.c | 13 ++++--- ole/olesvr.c | 6 ++++ ole/storage.c | 93 ++++++++++++++++++++++++++++++++++++++++++++++---- 7 files changed, 180 insertions(+), 16 deletions(-) diff --git a/include/main.h b/include/main.h index ef3a94c81b..2a484b2190 100644 --- a/include/main.h +++ b/include/main.h @@ -9,6 +9,7 @@ extern BOOL32 MAIN_KernelInit(void); extern void MAIN_Usage(char*); extern BOOL32 MAIN_UserInit(void); extern BOOL32 MAIN_WineInit( int *argc, char *argv[] ); +extern int MAIN_GetLanguageID(char*lang, char*country, char*charset, char*dialect); extern BOOL32 RELAY_Init(void); extern void* CALL32_Init(void); diff --git a/ole/compobj.c b/ole/compobj.c index 9fa153209b..0a5fbbf939 100644 --- a/ole/compobj.c +++ b/ole/compobj.c @@ -238,6 +238,10 @@ OLESTATUS WINAPI CLSIDFromString32( /****************************************************************************** * WINE_StringFromCLSID [???] * Converts a GUID into the respective string representation. + * + * NOTES + * Why is this WINAPI? + * * RETURNS * the string representation and OLESTATUS */ diff --git a/ole/ifs.c b/ole/ifs.c index f126068f98..6e9c813f65 100644 --- a/ole/ifs.c +++ b/ole/ifs.c @@ -25,12 +25,16 @@ */ /****************************************************************************** - * IUnknown_AddRef [???] + * IUnknown_AddRef [VTABLE:IUNKNOWN.1] */ static ULONG WINAPI IUnknown_AddRef(LPUNKNOWN this) { TRACE(relay,"(%p)->AddRef()\n",this); return ++(this->ref); } + +/****************************************************************************** + * IUnknown_Release [VTABLE:IUNKNOWN.2] + */ static ULONG WINAPI IUnknown_Release(LPUNKNOWN this) { TRACE(relay,"(%p)->Release()\n",this); if (!--(this->ref)) { @@ -40,6 +44,9 @@ static ULONG WINAPI IUnknown_Release(LPUNKNOWN this) { return this->ref; } +/****************************************************************************** + * IUnknown_QueryInterface [VTABLE:IUNKNOWN.0] + */ static HRESULT WINAPI IUnknown_QueryInterface(LPUNKNOWN this,REFIID refiid,LPVOID *obj) { char xrefiid[50]; @@ -59,7 +66,9 @@ static IUnknown_VTable uvt = { IUnknown_Release }; - +/****************************************************************************** + * IUnknown_Constructor [INTERNAL] + */ LPUNKNOWN IUnknown_Constructor() { LPUNKNOWN unk; @@ -107,29 +116,49 @@ HRESULT WINAPI IMalloc16_QueryInterface(LPMALLOC16 this,REFIID refiid,LPVOID *ob return OLE_E_ENUM_NOMORE; } +/****************************************************************************** + * IMalloc16_Alloc [COMPOBJ.503] + */ LPVOID WINAPI IMalloc16_Alloc(LPMALLOC16 this,DWORD cb) { TRACE(relay,"(%p)->Alloc(%ld)\n",this,cb); return (LPVOID)PTR_SEG_OFF_TO_SEGPTR(this->heap,LOCAL_Alloc(this->heap,0,cb)); } +/****************************************************************************** + * IMalloc16_Realloc [COMPOBJ.504] + */ LPVOID WINAPI IMalloc16_Realloc(LPMALLOC16 this,LPVOID pv,DWORD cb) { TRACE(relay,"(%p)->Realloc(%p,%ld)\n",this,pv,cb); return (LPVOID)PTR_SEG_OFF_TO_SEGPTR(this->heap,LOCAL_ReAlloc(this->heap,0,LOWORD(pv),cb)); } + +/****************************************************************************** + * IMalloc16_Free [COMPOBJ.505] + */ VOID WINAPI IMalloc16_Free(LPMALLOC16 this,LPVOID pv) { TRACE(relay,"(%p)->Free(%p)\n",this,pv); LOCAL_Free(this->heap,LOWORD(pv)); } +/****************************************************************************** + * IMalloc16_GetSize [COMPOBJ.506] + */ DWORD WINAPI IMalloc16_GetSize(LPMALLOC16 this,LPVOID pv) { TRACE(relay,"(%p)->GetSize(%p)\n",this,pv); return LOCAL_Size(this->heap,LOWORD(pv)); } +/****************************************************************************** + * IMalloc16_DidAlloc [COMPOBJ.507] + */ INT16 WINAPI IMalloc16_DidAlloc(LPMALLOC16 this,LPVOID pv) { TRACE(relay,"(%p)->DidAlloc(%p)\n",this,pv); return (INT16)-1; } + +/****************************************************************************** + * IMalloc16_HeapMinimize [COMPOBJ.508] + */ LPVOID WINAPI IMalloc16_HeapMinimize(LPMALLOC16 this) { TRACE(relay,"(%p)->HeapMinimize()\n",this); return NULL; @@ -151,6 +180,9 @@ static IMalloc16_VTable mvt16 = { #endif static IMalloc16_VTable *msegvt16 = NULL; +/****************************************************************************** + * IMalloc16_Constructor [VTABLE] + */ LPMALLOC16 IMalloc16_Constructor() { LPMALLOC16 this; @@ -186,7 +218,7 @@ IMalloc16_Constructor() { */ /****************************************************************************** - * IMalloc32_AddRef [???] + * IMalloc32_AddRef [VTABLE] */ static ULONG WINAPI IMalloc32_AddRef(LPMALLOC32 this) { TRACE(relay,"(%p)->AddRef()\n",this); @@ -194,7 +226,7 @@ static ULONG WINAPI IMalloc32_AddRef(LPMALLOC32 this) { } /****************************************************************************** - * IMalloc32_Release [???] + * IMalloc32_Release [VTABLE] */ static ULONG WINAPI IMalloc32_Release(LPMALLOC32 this) { TRACE(relay,"(%p)->Release()\n",this); @@ -202,7 +234,7 @@ static ULONG WINAPI IMalloc32_Release(LPMALLOC32 this) { } /****************************************************************************** - * IMalloc32_QueryInterface [???] + * IMalloc32_QueryInterface [VTABLE] */ static HRESULT WINAPI IMalloc32_QueryInterface(LPMALLOC32 this,REFIID refiid,LPVOID *obj) { char xrefiid[50]; @@ -218,29 +250,49 @@ static HRESULT WINAPI IMalloc32_QueryInterface(LPMALLOC32 this,REFIID refiid,LPV return OLE_E_ENUM_NOMORE; } +/****************************************************************************** + * IMalloc32_Alloc [VTABLE] + */ static LPVOID WINAPI IMalloc32_Alloc(LPMALLOC32 this,DWORD cb) { TRACE(relay,"(%p)->Alloc(%ld)\n",this,cb); return HeapAlloc(GetProcessHeap(),0,cb); } +/****************************************************************************** + * IMalloc32_Realloc [VTABLE] + */ static LPVOID WINAPI IMalloc32_Realloc(LPMALLOC32 this,LPVOID pv,DWORD cb) { TRACE(relay,"(%p)->Realloc(%p,%ld)\n",this,pv,cb); return HeapReAlloc(GetProcessHeap(),0,pv,cb); } + +/****************************************************************************** + * IMalloc32_Free [VTABLE] + */ static VOID WINAPI IMalloc32_Free(LPMALLOC32 this,LPVOID pv) { TRACE(relay,"(%p)->Free(%p)\n",this,pv); HeapFree(GetProcessHeap(),0,pv); } +/****************************************************************************** + * IMalloc32_GetSize [VTABLE] + */ static DWORD WINAPI IMalloc32_GetSize(LPMALLOC32 this,LPVOID pv) { TRACE(relay,"(%p)->GetSize(%p)\n",this,pv); return HeapSize(GetProcessHeap(),0,pv); } +/****************************************************************************** + * IMalloc32_DidAlloc [VTABLE] + */ static INT32 WINAPI IMalloc32_DidAlloc(LPMALLOC32 this,LPVOID pv) { TRACE(relay,"(%p)->DidAlloc(%p)\n",this,pv); return -1; } + +/****************************************************************************** + * IMalloc32_HeapMinimize [VTABLE] + */ static LPVOID WINAPI IMalloc32_HeapMinimize(LPMALLOC32 this) { TRACE(relay,"(%p)->HeapMinimize()\n",this); return NULL; @@ -258,6 +310,9 @@ static IMalloc32_VTable VT_IMalloc32 = { IMalloc32_HeapMinimize, }; +/****************************************************************************** + * IMalloc32_Constructor [VTABLE] + */ LPMALLOC32 IMalloc32_Constructor() { LPMALLOC32 this; diff --git a/ole/ole2disp.c b/ole/ole2disp.c index d5963e0506..58f7dfc22f 100644 --- a/ole/ole2disp.c +++ b/ole/ole2disp.c @@ -26,11 +26,17 @@ static BSTR16 BSTR_AllocBytes(int n) return (BSTR16)SEGPTR_GET(ptr); } +/****************************************************************************** + * BSTR_Free [INTERNAL] + */ static void BSTR_Free(BSTR16 in) { SEGPTR_FREE( PTR_SEG_TO_LIN(in) ); } +/****************************************************************************** + * BSTR_GetAddr [INTERNAL] + */ static void* BSTR_GetAddr(BSTR16 in) { return in ? PTR_SEG_TO_LIN(in) : 0; @@ -123,6 +129,9 @@ int WINAPI SysStringLen16(BSTR16 str) return strlen(BSTR_GetAddr(str)); } +/****************************************************************************** + * CreateDispTypeInfo [OLE2DISP.31] + */ OLESTATUS WINAPI CreateDispTypeInfo( INTERFACEDATA *pidata, LCID lcid, @@ -132,11 +141,14 @@ OLESTATUS WINAPI CreateDispTypeInfo( return 0; } +/****************************************************************************** + * RegisterActiveObject [OLE2DISP.35] + */ OLESTATUS WINAPI RegisterActiveObject( IUnknown * punk,REFCLSID rclsid,DWORD dwFlags, DWORD * pdwRegister ) { char buf[80]; WINE_StringFromCLSID(rclsid,buf); - FIXME(ole,"RegisterActiveObject(%p,%s,0x%08lx,%p),stub\n",punk,buf,dwFlags,pdwRegister); + FIXME(ole,"(%p,%s,0x%08lx,%p):stub\n",punk,buf,dwFlags,pdwRegister); return 0; } diff --git a/ole/ole2nls.c b/ole/ole2nls.c index 6b693937f8..0f74935162 100644 --- a/ole/ole2nls.c +++ b/ole/ole2nls.c @@ -16,8 +16,7 @@ #include "winreg.h" #include "winerror.h" #include "debug.h" - -int MAIN_GetLanguageID(char*lang, char*country, char*charset, char*dialect); +#include "main.h" /* Locale name to id map. used by EnumSystemLocales, GetLocalInfoA * MUST contain all #defines from winnls.h @@ -413,6 +412,9 @@ INT16 WINAPI GetLocaleInfo16(LCID lcid,LCTYPE LCType,LPSTR buf,INT16 len) return GetLocaleInfo32A(lcid,LCType,buf,len); } +/****************************************************************************** + * GetLocaleInfo32A [KERNEL32.342] + */ INT32 WINAPI GetLocaleInfo32A(LCID lcid,LCTYPE LCType,LPSTR buf,INT32 len) { char *retString; @@ -1777,6 +1779,9 @@ static const unsigned char LCM_Diacritic_LUT[] = { 19, /* ΓΏ - 255 */ } ; +/****************************************************************************** + * OLE2NLS_isPunctuation [INTERNAL] + */ static int OLE2NLS_isPunctuation(unsigned char c) { /* "punctuation character" in this context is a character which is @@ -2416,8 +2421,8 @@ INT32 WINAPI OLE_GetFormatA(LCID locale, return outpos; } -/************************************************************** - * OLE_GetFormatW [internal] +/****************************************************************************** + * OLE_GetFormatW [INTERNAL] */ INT32 WINAPI OLE_GetFormatW(LCID locale, DWORD flags, DWORD tflags, LPSYSTEMTIME xtime, diff --git a/ole/olesvr.c b/ole/olesvr.c index 2c6980810c..378e3a5b95 100644 --- a/ole/olesvr.c +++ b/ole/olesvr.c @@ -105,12 +105,18 @@ OLESTATUS WINAPI OleRevokeServer(LHSERVER hServer) return OLE_OK; } +/****************************************************************************** + * OleRegisterServer32 [OLESVR32.2] + */ OLESTATUS WINAPI OleRegisterServer32(LPCSTR svrname,LPOLESERVER olesvr,LHSERVER* hRet,HINSTANCE32 hinst,OLE_SERVER_USE osu) { FIXME(ole,"(%s,%p,%p,%08x,%d): stub!\n",svrname,olesvr,hRet,hinst,osu); *hRet=++OLE_current_handle; return OLE_OK; } +/****************************************************************************** + * OleRegisterServerDoc32 [OLESVR32.6] + */ OLESTATUS WINAPI OleRegisterServerDoc32( LHSERVER hServer, LPCSTR docname, LPOLESERVERDOC document, LHSERVERDOC *hRet) diff --git a/ole/storage.c b/ole/storage.c index 893c7a1d9b..fac9350532 100644 --- a/ole/storage.c +++ b/ole/storage.c @@ -40,7 +40,7 @@ static IStream16_VTable strvt16; static IStream16_VTable *segstrvt16 = NULL; static IStream32_VTable strvt32; -ULONG WINAPI IStorage16_AddRef(LPSTORAGE16 this); +/*ULONG WINAPI IStorage16_AddRef(LPSTORAGE16 this);*/ static void _create_istorage16(LPSTORAGE16 *stg); static void _create_istream16(LPSTREAM16 *str); @@ -67,6 +67,9 @@ STORAGE_get_big_block(HFILE32 hf,int n,BYTE *block) { return TRUE; } +/****************************************************************************** + * STORAGE_put_big_block [INTERNAL] + */ static BOOL32 STORAGE_put_big_block(HFILE32 hf,int n,BYTE *block) { assert(n>=-1); @@ -82,6 +85,9 @@ STORAGE_put_big_block(HFILE32 hf,int n,BYTE *block) { return TRUE; } +/****************************************************************************** + * STORAGE_get_next_big_blocknr [INTERNAL] + */ static int STORAGE_get_next_big_blocknr(HFILE32 hf,int blocknr) { INT32 bbs[BIGSIZE/sizeof(INT32)]; @@ -98,6 +104,9 @@ STORAGE_get_next_big_blocknr(HFILE32 hf,int blocknr) { return bbs[blocknr&0x7f]; } +/****************************************************************************** + * STORAGE_get_nth_next_big_blocknr [INTERNAL] + */ static int STORAGE_get_nth_next_big_blocknr(HFILE32 hf,int blocknr,int nr) { INT32 bbs[BIGSIZE/sizeof(INT32)]; @@ -148,6 +157,9 @@ STORAGE_get_root_pps_entry(HFILE32 hf,struct storage_pps_entry *pstde) { return FALSE; } +/****************************************************************************** + * STORAGE_get_small_block [INTERNAL] + */ static BOOL32 STORAGE_get_small_block(HFILE32 hf,int blocknr,BYTE *sblock) { BYTE block[BIGSIZE]; @@ -164,6 +176,9 @@ STORAGE_get_small_block(HFILE32 hf,int blocknr,BYTE *sblock) { return TRUE; } +/****************************************************************************** + * STORAGE_put_small_block [INTERNAL] + */ static BOOL32 STORAGE_put_small_block(HFILE32 hf,int blocknr,BYTE *sblock) { BYTE block[BIGSIZE]; @@ -182,7 +197,9 @@ STORAGE_put_small_block(HFILE32 hf,int blocknr,BYTE *sblock) { return TRUE; } - +/****************************************************************************** + * STORAGE_get_next_small_blocknr [INTERNAL] + */ static int STORAGE_get_next_small_blocknr(HFILE32 hf,int blocknr) { BYTE block[BIGSIZE]; @@ -199,6 +216,9 @@ STORAGE_get_next_small_blocknr(HFILE32 hf,int blocknr) { return sbd[blocknr & (128-1)]; } +/****************************************************************************** + * STORAGE_get_nth_next_small_blocknr [INTERNAL] + */ static int STORAGE_get_nth_next_small_blocknr(HFILE32 hf,int blocknr,int nr) { int lastblocknr; @@ -225,6 +245,9 @@ STORAGE_get_nth_next_small_blocknr(HFILE32 hf,int blocknr,int nr) { return blocknr; } +/****************************************************************************** + * STORAGE_get_pps_entry [INTERNAL] + */ static int STORAGE_get_pps_entry(HFILE32 hf,int n,struct storage_pps_entry *pstde) { int blocknr; @@ -324,6 +347,9 @@ STORAGE_dump_pps_entry(struct storage_pps_entry *stde) { DUMP("size: %ld\n",stde->pps_size); } +/****************************************************************************** + * STORAGE_init_storage [INTERNAL] + */ static BOOL32 STORAGE_init_storage(HFILE32 hf) { BYTE block[BIGSIZE]; @@ -393,6 +419,9 @@ STORAGE_set_big_chain(HFILE32 hf,int blocknr,INT32 type) { return TRUE; } +/****************************************************************************** + * STORAGE_set_small_chain [INTERNAL] + */ static BOOL32 STORAGE_set_small_chain(HFILE32 hf,int blocknr,INT32 type) { BYTE block[BIGSIZE]; @@ -621,10 +650,16 @@ HRESULT WINAPI IStream16_QueryInterface( } +/****************************************************************************** + * IStream16_AddRef [STORAGE.519] + */ ULONG WINAPI IStream16_AddRef(LPSTREAM16 this) { return ++(this->ref); } +/****************************************************************************** + * IStream16_Release [STORAGE.520] + */ ULONG WINAPI IStream16_Release(LPSTREAM16 this) { FlushFileBuffers(this->hf); this->ref--; @@ -1061,7 +1096,7 @@ static void _create_istream16(LPSTREAM16 *str) { } /***************************************************************************** - * IStream32_QueryInterface [???] + * IStream32_QueryInterface [VTABLE] */ HRESULT WINAPI IStream32_QueryInterface( LPSTREAM32 this,REFIID refiid,LPVOID *obj @@ -1078,10 +1113,16 @@ HRESULT WINAPI IStream32_QueryInterface( } +/****************************************************************************** + * IStream32_AddRef [VTABLE] + */ ULONG WINAPI IStream32_AddRef(LPSTREAM32 this) { return ++(this->ref); } +/****************************************************************************** + * IStream32_Release [VTABLE] + */ ULONG WINAPI IStream32_Release(LPSTREAM32 this) { FlushFileBuffers(this->hf); this->ref--; @@ -1126,10 +1167,16 @@ HRESULT WINAPI IStorage16_QueryInterface( return OLE_E_ENUM_NOMORE; } +/****************************************************************************** + * IStorage16_AddRef [STORAGE.501] + */ ULONG WINAPI IStorage16_AddRef(LPSTORAGE16 this) { return ++(this->ref); } +/****************************************************************************** + * IStorage16_Release [STORAGE.502] + */ ULONG WINAPI IStorage16_Release(LPSTORAGE16 this) { this->ref--; if (this->ref) @@ -1138,6 +1185,9 @@ ULONG WINAPI IStorage16_Release(LPSTORAGE16 this) { return 0; } +/****************************************************************************** + * IStorage16_Stat [STORAGE.517] + */ HRESULT WINAPI IStorage16_Stat( LPSTORAGE16 this,STATSTG *pstatstg, DWORD grfStatFlag ) { @@ -1170,6 +1220,9 @@ HRESULT WINAPI IStorage16_Commit( return OLE_OK; } +/****************************************************************************** + * IStorage16_CopyTo [STORAGE.507] + */ HRESULT WINAPI IStorage16_CopyTo(LPSTORAGE16 this,DWORD ciidExclude,const IID *rgiidExclude,SNB16 SNB16Exclude,IStorage16 *pstgDest) { char xguid[50]; @@ -1184,7 +1237,9 @@ HRESULT WINAPI IStorage16_CopyTo(LPSTORAGE16 this,DWORD ciidExclude,const IID *r } - +/****************************************************************************** + * IStorage16_CreateStorage [STORAGE.505] + */ HRESULT WINAPI IStorage16_CreateStorage( LPSTORAGE16 this,LPCOLESTR16 pwcsName,DWORD grfMode,DWORD dwStgFormat,DWORD reserved2, IStorage16 **ppstg ) { @@ -1325,6 +1380,9 @@ HRESULT WINAPI IStorage16_OpenStorage( return OLE_OK; } +/****************************************************************************** + * IStorage16_OpenStream [STORAGE.504] + */ HRESULT WINAPI IStorage16_OpenStream( LPSTORAGE16 this,LPCOLESTR16 pwcsName, void *reserved1, DWORD grfMode, DWORD reserved2, IStream16 **ppstm ) { @@ -1357,6 +1415,9 @@ HRESULT WINAPI IStorage16_OpenStream( return OLE_OK; } +/****************************************************************************** + * _create_istorage16 [INTERNAL] + */ static void _create_istorage16(LPSTORAGE16 *stg) { LPSTORAGE16 lpst; @@ -1420,7 +1481,7 @@ static void _create_istorage16(LPSTORAGE16 *stg) { } /****************************************************************************** - * IStorage32_QueryInterface [???] + * IStorage32_QueryInterface [VTABLE] */ HRESULT WINAPI IStorage32_QueryInterface( LPSTORAGE32 this,REFIID refiid,LPVOID *obj @@ -1437,10 +1498,16 @@ HRESULT WINAPI IStorage32_QueryInterface( return OLE_E_ENUM_NOMORE; } +/****************************************************************************** + * IStorage32_AddRef [VTABLE] + */ ULONG WINAPI IStorage32_AddRef(LPSTORAGE32 this) { return ++(this->ref); } +/****************************************************************************** + * IStorage32_Release [VTABLE] + */ ULONG WINAPI IStorage32_Release(LPSTORAGE32 this) { this->ref--; if (this->ref) @@ -1449,6 +1516,9 @@ ULONG WINAPI IStorage32_Release(LPSTORAGE32 this) { return 0; } +/****************************************************************************** + * IStorage32_CreateStream [VTABLE] + */ HRESULT WINAPI IStorage32_CreateStream( LPSTORAGE32 this,LPCOLESTR32 pwcsName,DWORD grfMode,DWORD reserved1,DWORD reserved2, IStream32 **ppstm ) { @@ -1462,6 +1532,9 @@ HRESULT WINAPI IStorage32_CreateStream( return OLE_OK; } +/****************************************************************************** + * IStorage32_OpenStream [VTABLE] + */ HRESULT WINAPI IStorage32_OpenStream( LPSTORAGE32 this,LPCOLESTR32 pwcsName, void *reserved1, DWORD grfMode, DWORD reserved2, IStream32 **ppstm ) { @@ -1555,6 +1628,9 @@ OLESTATUS WINAPI StgCreateDocFile32( return OLE_OK; } +/****************************************************************************** + * StgIsStorageFile16 [STORAGE.5] + */ OLESTATUS WINAPI StgIsStorageFile16(LPCOLESTR16 fn) { HFILE32 hf; OFSTRUCT ofs; @@ -1589,6 +1665,9 @@ OLESTATUS WINAPI StgIsStorageFile16(LPCOLESTR16 fn) { return STG_E_INVALIDHEADER; } +/****************************************************************************** + * StgIsStorageFile32 [OLE32.146] + */ OLESTATUS WINAPI StgIsStorageFile32(LPCOLESTR32 fn) { @@ -1600,7 +1679,9 @@ StgIsStorageFile32(LPCOLESTR32 fn) } - +/****************************************************************************** + * StgOpenStorage16 [STORAGE.3] + */ OLESTATUS WINAPI StgOpenStorage16( const OLECHAR16 * pwcsName,IStorage16 *pstgPriority,DWORD grfMode, SNB16 snbExclude,DWORD reserved, IStorage16 **ppstgOpen -- 2.32.0.93.g670b81a890