opencbm-plugin-install.h

Go to the documentation of this file.

/*
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version
 *  2 of the License, or (at your option) any later version.
 *
 *  Copyright 2008-2009, 2011, 2014 Spiro Trikaliotis
 */

#ifndef OPENCBM_PLUGIN_INSTALL_H
#define OPENCBM_PLUGIN_INSTALL_H

#include "opencbm-plugin.h"

#ifdef WIN32
    /*
     * special functions for installing on Windows
     * These functions are not used in the normal process, only for installation.
     * Thus, they are missing in opencbm_plugin_s and opencbm_plugin_t.
     */

    // int (*p_opencbm_install_getopt)(int argc, char * const argv[], const char *optstring);

    

    typedef int CBMAPIDECL opencbm_plugin_install_getopt_long_callback_t(int Argc, char * const Argv[], const char *Optstring, const struct option *Longopts);

    typedef
    enum osversion_e
    {
        WINUNSUPPORTED, 
        WINNT3,         
        WINNT4,         
        WIN2000,        
        WINXP,          
        WINVISTA,       
        WIN7,           
        WIN8,           
        WIN8_1,         
        WINNEWER        
    } osversion_t;

    typedef
    struct opencbm_plugin_install_neededfiles_s opencbm_plugin_install_neededfiles_t;

    typedef
    struct cbm_install_parameter_plugin_s 
    {
        struct cbm_install_parameter_plugin_s *Next;        
        char * FileName;                                    
        char * Name;                                        
        void * OptionMemory;                                
        opencbm_plugin_install_neededfiles_t * NeededFiles; 
    } cbm_install_parameter_plugin_t;


    typedef
    struct cbm_install_parameter_s
    {
        BOOL NoExecute;

        BOOL AdminNeeded;

        BOOL ExecuteParameterGiven;

        BOOL Install;

        BOOL Remove;

        BOOL Purge;

        BOOL NoCopy;

        BOOL Update;

        BOOL CheckInstall;

        BOOL OutputDebuggingBuffer;

        BOOL DebugFlagsDriverWereGiven;

        BOOL DebugFlagsDllWereGiven;

        BOOL DebugFlagsInstallWereGiven;

        ULONG DebugFlagsDriver;

        ULONG DebugFlagsDll;

        ULONG DebugFlagsInstall;

        osversion_t OsVersion;

        // @@@ char ** PluginNames;
        cbm_install_parameter_plugin_t * PluginList;

        BOOL NoExplicitPluginGiven;

        char * DefaultAdapter;

    } opencbm_install_parameter_t;

    typedef struct CbmPluginInstallProcessCommandlineData_s {
        int    Argc;          
        char * const * Argv;  
        void * OptionMemory;  
        char **OptArg;        
        int  * OptInd;        
        int  * OptErr;        
        int  * OptOpt;        
        opencbm_plugin_install_getopt_long_callback_t * GetoptLongCallback; 
        opencbm_install_parameter_t                   * InstallParameter;   
    } CbmPluginInstallProcessCommandlineData_t;

    
    typedef unsigned int CBMAPIDECL opencbm_plugin_install_process_commandline_t(CbmPluginInstallProcessCommandlineData_t * ProcessCommandlineData); 

    
    typedef BOOL CBMAPIDECL opencbm_plugin_install_do_install_t(void * OptionMemory);

    typedef BOOL CBMAPIDECL opencbm_plugin_install_do_uninstall_t(void * OptionMemory);

    typedef
    enum opencbm_plugin_install_location_e
    {
        LOCAL_DIR,        
        LOCAL_PLUGIN_DIR, 
        SYSTEM_DIR,       
        DRIVER_DIR,       
        LIST_END          
    } opencbm_plugin_install_location_t;

    typedef
    struct opencbm_plugin_install_neededfiles_s
    {
        opencbm_plugin_install_location_t FileLocation;       
        const char                        Filename[100];      
        const char                      * FileLocationString; 
    } opencbm_plugin_install_neededfiles_t;

    
    typedef unsigned int CBMAPIDECL opencbm_plugin_install_get_needed_files_t(CbmPluginInstallProcessCommandlineData_t * Data, opencbm_plugin_install_neededfiles_t * Destination);


    #define INDEX_DEFAULT_FILENAME_LOCAL 0
    #define INDEX_DEFAULT_FILENAME_USERDIR 1
    #define INDEX_DEFAULT_FILENAME_WINDIR 2

    typedef BOOL CBMAPIDECL opencbm_plugin_install_generic_t(const char * DefaultPluginname, unsigned int DefaultLocation);

    typedef BOOL CBMAPIDECL opencbm_plugin_install_plugin_data_t(const char * Pluginname, const char * Filepath, const CbmPluginInstallProcessCommandlineData_t * CommandlineData);


    typedef BOOL CBMAPIDECL opencbm_plugin_get_all_plugin_names_callback_t(opencbm_install_parameter_t * InstallParameter, const char * Pluginname);

    typedef struct opencbm_plugin_get_all_plugin_names_context_s {
        opencbm_plugin_get_all_plugin_names_callback_t * Callback;         
        opencbm_install_parameter_t                    * InstallParameter; 
    } opencbm_plugin_get_all_plugin_names_context_t;

    typedef BOOL CBMAPIDECL opencbm_plugin_get_all_plugin_names_t(opencbm_plugin_get_all_plugin_names_context_t * Callback);

    typedef int CBMAPIDECL opencbm_plugin_self_init_plugin_t(void);

    typedef int CBMAPIDECL opencbm_plugin_self_uninit_plugin_t(void);

#endif

#endif // #ifndef OPENCBM_PLUGIN_INSTALL_H