mqproperty.h

Go to the documentation of this file.

#ifndef _MQPROPERTY_H_
#define _MQPROPERTY_H_

/* Copyright (c) Kyriacos Leptos and the President and Fellows of Harvard University
   Release Date: 2004-11-01
   Part of the MapQuant suite library "mqbasic.lib" 
*/

#define     MQPROPERTY_FILE_EXT          "prf"

extern char*  MQPROPERTY_GLOBAL_PATHNAME; // usually set by environment variable 
extern char*  MQPROPERTY_LOCAL_PATHNAME;
extern MQByte MQPROPERTY_LOCAL_PATHNAME_LOADED;

int         MQProperty_saveToLocalFile   (char* property_value, char* property_name);

char*       MQProperty_loadFromFileAsString(char* property_name, char* filename);

int         MQProperty_loadFromFile      (const void* property_value, char* property_name, char* filename, int type);
int         MQProperty_loadFromGlobalFile(const void* property_value, char* property_name, int type);
int         MQProperty_loadFromLocalFile (const void* property_value, char* property_name, int type);

int         MQProperty_load(const void* property_value, char* property_name, int type, char* function_name);

int         MQProperty_setGlobalFile(char* global_property_file);
int         MQProperty_setLocalFile(char* local_property_file);

void        MQProperty_releasePrefs();
char*       MQProperty_findInPathOfExecutable(char* executable_name, char* properties_file);

extern char parameter_name[MAX_LINE_LENGTH];
extern char parameter_value[MAX_LINE_LENGTH];

#define MQPROPERTY_READ(name, bitstring)                                        \
{                                                                               \
    char* mqstr;                                                                \
    if(MQProperty_loadFromLocalFile(&mqstr, #name, MQ_STRING))                  \
    {                                                                           \
        if(VERBOSE == 1)                                                        \
            printf("%s loaded from preferences file\n", #name);                 \
        if (bitstring & name ## _SET)   free(name);                             \
        name = MQString_dup(mqstr);                                             \
        bitstring |= name ## _SET;                                              \
    }                                                                           \
    else if(MQProperty_loadFromGlobalFile(&mqstr, #name, MQ_STRING))            \
    {                                                                           \
        if(VERBOSE == 1)                                                        \
            printf("%s loaded from global file\n", #name);                      \
        if (bitstring & name ## _SET) free(name);                               \
        name = MQString_dup(mqstr);                                             \
        bitstring |= name ## _SET;                                              \
    }                                                                           \
    else                                                                        \
    {                                                                           \
        fprintf(stderr, "MQPROPERTY_READ: Variable %s not found\n", #name);     \
        exit(MQERROR_PROPERTY_NOT_FOUND);                                       \
    }                                                                           \
}

#define MQPROPERTY_FREE(name, bitstring)            \
if (bitstring & name ## _SET)                       \
{   bitstring &= (~(name ## _SET));                 \
    free(name);                                     \
}

#define GET_PARAMETER(NAME, value)                          \
if (!strcmp(parameter_name, NAME))                          \
{                                                           \
    sscanf(line, "%s %s", parameter_name, parameter_value); \
    value = MQString_dup(parameter_value);                  \
    found = 1;                                              \
}

#endif

---