maul-esel / com-classes Goto Github PK

finish CF class. The most important thing: implement CF.GetWindowsVersion().

Check out structure padding and correct all structure classes to obey it. This may solve #27.

What

There should possibly be a base class for enum classes.

Advantages 👍

This allows them to

• inherit _CCF_Error_Handler_ (important if there are methods, e.g. as in CF)
• define a constructor similar to CCFramework

Disadvantages 👎

• one more class requirement

There are still a lot of places where Unknown._GUID() is used. Fix that!

Raw memory pointers should be allowed for each place where a GUID or a pointer to it is needed.
This includes support in struct classes.

Related

maybe the memory can be copied (for structures) ?

Add _ShellLinkA_ class (should be easy as _ShellLinkW_ is already wrapped). This is a split-off from #17.

add msdn doc links for each class (comments)

Hello maul.esel

your latest change on TaskbarList3 (c3517c8) breaks example2 (at least on my machine):

• Only the first thumbbar-button contains an icon - all others are shown as borders only (i.e. no icon is shown, only border)
• Unless there should be 6 icons actually are only 5 drawn (1 real icon - and four border-only icons (it seems one border-only icon is missing))
• Hovering over the first (correct rendered) button almost shows up the expected tooltip (expected: "This is button #1" - actually shown: "is button #1") All other (border-only) icons do NOT show any tooltip
• Clicking on the first icon brings up the following msgbox as expected: "The ThumbBar button with the id "1" was clicked!". Clicking on the other items also pop up a msgbox - but the shown ID is wrong: 2nd button shows id 47, 3rd button shows id 84 ...

(used for test: pre-change AHK_L 1.1 version <-> post change AHK2 version. Therefore I'm not quite sure which of the described problems already occur with pre-change AHK_2 version ...)

Can't figure it out how to fix it myself - else I did it already ....

EDIT: Initial assumption that bug was introduced with latest version seems not to be correct. The bug seems to exist since ever (using AHK2 variant on Win7 64bit OS)

Minimize dependencies

Achieve less dependencies for each class by

• ensuring every function that accepts another instance of a COM class can also handle a raw pointer
• the same for struct classes
• ensuring every function that returns an instance of a COM class (or retrieves it via byRef) returns a raw pointer if the class is not available
• the same for struct class fields
• document this

• investigate on and implement IImageList2::SetCallback / IImageList2::GetCallback
• add an example
• fix methods marked as "NOT WORKING" in ImageList

Add "header" files, similar to CCF.ahk, but only for parts of CCF. Examples would be:

• Base classes, TaskbarList - TaskbarList4 & helper classes
• Base classes, UIAutomation classes
• Base classes, Type information classes + Helper classes

add a short description to the top of each example

return types

Change all COM methods to explicitly specify their return type (most of the time "UInt") to ensure the code doesn't break on a possible future change in AHK.

method & NumGet()

The same for all those calls to NumGet() retrieving the method adresses.

Rethink the directory structure. Especially: the different types of helper classes should be separated.

What

Make local variables in _all_ methods in _all_ classes explicitly local (declare them).

Why

To avoid overriding super-global variables

After the bugfix (http://www.autohotkey.com/forum/viewtopic.php?p=517398#517398) , which allows using ObjTree (http://http://www.autohotkey.com/forum/viewtopic.php?t=69756) to display objects from CCF, still one fatal error exists:

At the end of the following example program, AHK2 crashes and pops up a window (german OS): "Autohotkey_L funktioniert nicht mehr".

#SingleInstance
#include ..\..\_CCF_Error_Handler_.ahk
#include ..\..\CCFramework.ahk
#Include ..\..\Unknown\Unknown.ahk
#Include ..\..\ShellItem\ShellItem.ahk
#Include ..\..\Constant Classes\SIGDN.ahk
#Include ..\..\Constant Classes\SFGAO.ahk
#Include ..\..\Constant Classes\KNOWNFOLDERID.ahk


; #############################################
; Explicit filepath
shItem := ShellItem.FromAbsolutePath(A_AhkPath)

ObjTree(shItem)

; display a few names
MsgBox % "NORMALDISPLAY: <" shItem.GetDisplayName() ">`nFILESYSPATH: <" shItem.GetDisplayName(SIGDN.FILESYSPATH) ">`nDESKTOPABSOLUTEEDITING: <" shItem.GetDisplayName(SIGDN.DESKTOPABSOLUTEEDITING) ">`nPARENTRELATIVEFORADDRESSBAR: <" shItem.GetDisplayName(SIGDN.PARENTRELATIVEFORADDRESSBAR) ">"

; checking some attributes
ret := shItem.GetAttributes((SFGAO.HASPROPSHEET | SFGAO.ENCRYPTED | SFGAO.FOLDER | SFGAO.BROWSABLE), bits)
; to display wheter the flag is set or not, we use Utility function - or some bitwise operations
MsgBox % "HASPROPSHEET: <" CCFramework.HasEnumFlag(bits, SFGAO.HASPROPSHEET) ">`nENCRYPTED: <" CCFramework.HasEnumFlag(bits,SFGAO.ENCRYPTED) ">`nFOLDER: <" ((bits & SFGAO.FOLDER) > 0) ">`nBROWSABLE: <" ((bits & SFGAO.BROWSABLE) > 0) ">" 

I'm not quite sure, who's the culprit (either CCF, ObjTree, or AHK itself) - but it's beyond my capability to identify it ...

I many cases where memory is allocated for a GUID, it does not need to be persistent. Therefore VarSetCapacity() should be used in favor of AllocateMemory(). This should shorten the code and improve performance

Wrap ITypeLib2. This might be needed in ComGenerator & belongs to the other type information classes (include it in the specific header)..

Helper classes have already been wrapped (see #10 and others).

Memory allocated for structs returned to the user should be allocated in a way that it's persistent after the method returns.

To do so, allocate the memory using the "Heap functions" (CCFramework.AllocateMemory()). Also add a new method to structs: GetOriginalPointer(), which, if the instance was created by FromStructPtr(), returns the pointer it was created from (which only makes sense if it's still valid).

The user is responsible for releasing the memory (add a ReleaseOriginalPointer() method). In case of the TypeInfo structs, this allows struct instances to be passed to those Release*() methods, e.g. ITypeInfo::ReleaseFuncDesc().

Summary:

• Add:
  • StructBase.GetOriginalPointer()
  • StructBase.ReleaseOriginalPointer()
• Modify:
  • Struct classes & StructBase: FromStructPtr() to store the pointer
  • COM methods: allocate memory with CCFramework.AllocateMemory(), not VarSetCapacity().
• Check:
  • How far this affects nested structures...

What

The file spec.markdown (on the gh-pages branch) contains the beginnings of an explicit specification of requirements for CFF classes.

Todo:

• transfer wiki information to the spec
• extend it, e.g.
  • how to handle struct arrays?
  • should methods / structures accept string pointers?
  • provide standard functions / "macros", or a class containing those?
    • for example GUID<->string conversion, struct array conversion (?), ...

What

Whenever structs are created in a class and memory must be allocated for that, use the struct's GetRequiredSize() method for that.

Affected classes

• all "interface classes" that use structs

IUIAutomation: http://msdn.microsoft.com/en-us/library/windows/desktop/ee671406(v=VS.85).aspx
bewildr using IUIAutomation in ironruby: http://www.natontesting.com/2010/07/20/announcing-bewildr-test-your-wpf-ui-apps-with-ironruby/
https://github.com/GraemeF/Fluid
http://www.autoitscript.com/forum/topic/128406-interface-autoitobject-iuiautomation/

Edit: removed request for IAccessible as it already inherits from IDispatch

Wrap ITypeInfo2 and required helper classes. This might be needed in ComGenerator & belongs to the other type information classes (include it in the specific header).

Types to be wrapped:

• ELEMDESC
• FUNCDESC
• VARDESC
• BINDPTR Edit: BINDPTR is not a structure but a union.
• EXCEPINFO
• TYPEDESC
• CUSTDATA
• CUSTDATAITEM
• PARAMDESC
• PARAMDESCEX
• VARIANT ? (see here)
• DISPPARAMS
• SAFEARRAYBOUND
• ARRAYDESC

In any case where a structure class has a constructor, it must not require a parameter (optional parameters are OK).

What

Add more information to the documentation comments. For examples see this thread.

Affected classes

• all classes

Related

• Issue #7

Wrap ITypeComp. This might be needed by ComGenerator & belongs to the other type information classes (include it in the specific header). The required helper classes have to be wrapped, too (see issue #10).

The CCF header file is quite out-of -date and incomplete. All new interface classes + all helper classes must be #included here. #42 should be done before.

• Continue work on IRichEditOLE
• add a working example
• also implement TOM (text object model) classes to make efficient work with RichEdits easier

What

Add more documentation to helper classes, such as Requirements, license and so on.

Affected classes

• all helper classes, especially struct classes

Related

• Issue #6

There should be a documentation on CCF that includes general information, i.e. a more noob-friendly version of the spec.

Add the CLSCTX enum class. Also include "combined" values such as CLSCTX_ALL.

Correct the (DllCall-) types used. Especially: HWND must be Ptr instead of UInt.

Todo:

• push changes to branch AHK_Lv1.1

• correct parameter default values
• use Loop, Parse instead of LoopParse
• convert ANSI / Unicode:
  • Unknown has the _ToUnicode(str) method, but it is not yet working.
  • What encoding to use for libraries & demos _?_
  • possibly separate into AHKv1.1_U and AHKv1.1_A branches?

Adding a wrapper for IDispatch enables the user to simply create an instance with
instance := new Dispatch(ComObjUnwrap(myobj)).
Then he can easily call its methods, e.g. IDispatch::GetTypeInfo().

All structure class must not call CCFramework.AllocateMemory() directly, except when they also release the memory immediately. Otherwise, they should call this.Allocate() as all memory allocated this way is freed when the class instance is released.

A new method FreeAllMemory() should be added to StructBase.

It must be documented that all structure pointers are only valid as long as the class instance exists.

Wrap TOM (text object model) interfaces to allow efficient work with RichEdit controls & the RichEditOLE class.

For easier use of the PropertyStore class, some new features might be added:

• a constant class for PKEY_* values (as GUIDs or PROPERTYKEY instances)
• a method PropertyStore.FromHWND() (see here)
• #22
• maybe IPropertyDescription

Write tests and usage examples!

Show the full power of CCF, and verify methods work as intended. Right now, many methods (and entire classes) are untested _!_

Wrap IEnumSTATSTG (used with Storage class)

• msdn

• implement IShellLink::GetIDList / IShellLink::SetIDList and IShellLink::GetHotkey / IShellLink::SetHotkey.
• add ShellLinkA class

The methods

• IPropertyStore::GetValue
• IPropertyStore::SetValue
• IPropertyStoreCache::GetValueAndState and
• IPropertyStoreCache::SetValueAndState

need some handling for PROPVARIANT structures. This may must be done as a structure class or similar to the VARIANT handling.