Merge lp://staging/~smspillaz/compiz-libcompizconfig/refactor-context into lp://staging/~compiz-team/compiz-libcompizconfig/0.9.8

There's not much point to a structure that only contains a void pointer.

The pattern I'd expect is:

// *.h
typedef struct CCSContext CCSContext;
CCSContext* ccsContextCreate();
CCSPluginList ccsContextGetPlugins(CCSContext*);
...
void ccsContextDestroy(CCSContext*);

// *.cpp
struct CCSContext
{
    CCSBackend *backend;
    CCSPluginList plugins; /* list of plugins settings were loaded for */
    CCSPluginCategory *categories; /* list of plugin categories */
    void *privatePtr; /* private pointer that can be used by the caller */
    char *profile;
    Bool deIntegration;
    Bool pluginListAutoSort;

    unsigned int configWatchId;

    CCSSettingList changedSettings; /* list of settings changed since last settings write */

    unsigned int screenNum; /* screen number this context is assigned to */
    const CCSInterfaceTable *object_interfaces;
    const CCSContextInterface *interface;
} CCSContextPrivate;
...
CCSPluginList
ccsContextGetPluginsDefault (CCSContext* context)
{
  return context->plugins;
}
...

Maybe there is a reason for the extra complexity? But it escapes me.

> There's not much point to a structure that only contains a void pointer.
>
> The pattern I'd expect is:
>
> // *.h
> typedef struct CCSContext CCSContext;
> CCSContext* ccsContextCreate();
> CCSPluginList ccsContextGetPlugins(CCSContext*);
> ...
> void ccsContextDestroy(CCSContext*);
>
> // *.cpp
> struct CCSContext
> {
> CCSBackend *backend;
> CCSPluginList plugins; /* list of plugins settings were loaded for */
> CCSPluginCategory *categories; /* list of plugin categories */
> void *privatePtr; /* private pointer that can be used by the caller */
> char *profile;
> Bool deIntegration;
> Bool pluginListAutoSort;
>
> unsigned int configWatchId;
>
> CCSSettingList changedSettings; /* list of settings changed since last
> settings write */
>
> unsigned int screenNum; /* screen number this context is assigned to */
> const CCSInterfaceTable *object_interfaces;
> const CCSContextInterface *interface;
> } CCSContextPrivate;

Cut&past error - that should be "> };"

> ...
> CCSPluginList
> ccsContextGetPluginsDefault (CCSContext* context)
> {
> return context->plugins;
> }
> ...
>
> Maybe there is a reason for the extra complexity? But it escapes me.

Agreed, changing to opaque pointers was something I didn't remember to do yet. doing it now.

> There's not much point to a structure that only contains a void pointer.
>
> The pattern I'd expect is:
>
> // *.h
> typedef struct CCSContext CCSContext;
> CCSContext* ccsContextCreate();
> CCSPluginList ccsContextGetPlugins(CCSContext*);
> ...
> void ccsContextDestroy(CCSContext*);
>
> // *.cpp
> struct CCSContext
> {
> CCSBackend *backend;
> CCSPluginList plugins; /* list of plugins settings were loaded for */
> CCSPluginCategory *categories; /* list of plugin categories */
> void *privatePtr; /* private pointer that can be used by the caller */
> char *profile;
> Bool deIntegration;
> Bool pluginListAutoSort;
>
> unsigned int configWatchId;
>
> CCSSettingList changedSettings; /* list of settings changed since last
> settings write */
>
> unsigned int screenNum; /* screen number this context is assigned to */
> const CCSInterfaceTable *object_interfaces;
> const CCSContextInterface *interface;
> } CCSContextPrivate;
> ...
> CCSPluginList
> ccsContextGetPluginsDefault (CCSContext* context)
> {
> return context->plugins;
> }
> ...
>
> Maybe there is a reason for the extra complexity? But it escapes me.

See the next pipe - it contains a struct that contains a CCSObject (not by pointer). All this does is move the data behind an indirection pimpl.

I can think of no good reason that ccsPrivate is void* instead of CCSContextPrivate* - that would allow the implementation code to be simpler by removing the need for casts.

And I don't see why CONTEXT_PRIV and _CCSContextPrivate/CCSContextPrivate are defined in a header.

Which is "the next pipe"?