ProviderIndexUtil.qc.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  ProviderIndexUtil.qc Copyright 2025 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
namespace ProviderIndexUtil {
const ProviderIndexEnvVar = "QORE_PROVIDER_INDEX_DIR";
 
public hashdecl DataProviderIndexInfo {
    *hash<string, string> factorymap;
 
    *hash<string, hash<string, bool>> appmap;
 
    *hash<string, hash<string, bool>> schememap;
 
    *hash<string, hash<auto>> appinfomap;
 
 
    *hash<string, hash<string, hash<auto>>> actioninfomap;
 
 
    *hash<string, hash<auto>> top_actioninfomap;
};
 
public hashdecl ProviderIndexInfo {
    string path;
 
    int size;
 
    date delta;
 
    hash<auto> summary;
};
 
class ProviderIndexUtil {
 
public:
    
 
protected:
        static *LoggerInterface logger;
 
        static Mutex m();
 
        static *hash<DataProviderIndexInfo> index;
 
        static bool initialized;
 
        static bool apps_loaded;
 
public:
 
      static *list<hash<auto>> getCachedApps();
 
 
      static *list<hash<auto>> searchCachedAppRegex(string regex_pattern, int regex_options = RE_Caseless);
 
 
      static *list<hash<auto>> searchCachedAppSubstr(string substr, bool ignore_case = True);
 
      static *hash<auto> tryGetAppInfo(string app);
 
      static *list<hash<auto>> tryGetApproximateActionsForApp(string app);
 
      static *hash<auto> tryGetApproximateAppAction(string app, string action);
 
 
      static *list<hash<auto>> searchCachedAppActionRegex(string app, string regex_pattern, int regex_options = RE_Caseless);
 
 
      static *list<hash<auto>> searchCachedAppActionSubstr(string app, string substr, bool ignore_case = True);
 
 
      static *list<hash<auto>> searchCachedActionRegex(string regex_pattern, int regex_options = RE_Caseless);
 
 
      static *list<hash<auto>> searchCachedActionSubstr(string substr, bool ignore_case = True);
 
 
      static *list<hash<auto>> getAllCachedActions();
 
      static addAppToCache(hash<auto> app);
 
      static addActionToCache(hash<auto> action);
 
      static bool removeCachedApp(string app);
 
 
      static bool checkFactoryModule(string factory);
 
 
      static bool checkAppModule(string app);
 
 
      static bool checkSchemeModule(string scheme);
 
 
      static bool tryLoadModule(string mod);
 
      static *list<string> getAllAppModulesToLoad();
 
protected:
      static checkDataIndex();
public:
 
 
 
      static setGlobalLogger(*LoggerInterface logger);
 
 
      static *LoggerInterface getGlobalLogger();
 
      static hash<ProviderIndexInfo> writeDataProviderIndex(*hash<DataProviderIndexInfo> h, date delta, hash<auto> summary);
 
      static *hash<DataProviderIndexInfo> readDataProviderIndex();
 
protected:
      static hash<auto> deserializeActions(hash<string, hash<string, hash<auto>>> actioninfomap, TypedHash action_info_th, TypedHash option_info_th, TypedHash path_vars_th, hash<auto> type_map);
public:
 
 
protected:
      static hash<ProviderIndexInfo> writeIndex(*hash<auto> h, string type, date delta, hash<auto> summary);
public:
 
 
protected:
      static *hash<auto> readIndex(string type);
public:
 
 
      static string getIndexPath(string type);
 
      static setEnvironmentVariable(string dir);
 
      static *string tryGetIndexDir(*bool throw_exception);
 
      static log(Qore::Logger::LoggerLevel level, string fmt, ...);
 
      static logArgs(Qore::Logger::LoggerLevel level, string fmt, *softlist<auto> args);
};
};