ModulesConf.h

Go to the documentation of this file.

/* ModulesConf.h -*- c++ -*-
 *
 * Classes for reading the modules.conf configuration file.
 *
 * Author: Michal Svec <msvec@suse.cz>
 *         Daniel Vesely <dan@suse.cz>
 *
 * $Id$
 */

#ifndef ModulesConf_h
#define ModulesConf_h

#include <string>
#include <list>
#include <map>

using std::string;
using std::list;
using std::map;

#define MAX_LINE_LENGTH 256
#define WHITESPACE      " \t\n"

#define MAGIC_ENTRY     "Ctrl and Alt keys stuck -- press Del to continue."

class ModuleEntry {

public:

    enum Mode { INIT, SET, REINIT };
    typedef map <const string, string> EntryArg;
    typedef string EntryCom;

    ModuleEntry() : comment(), argument(), dirtyflag(false) {}

    ~ModuleEntry();

    EntryCom getComment() const;
    EntryArg getArgument() const { return argument; }
    bool setComment(const EntryCom &com, Mode m) { comment = com; return true; }
    bool setArgument(const string arg, Mode m);
    bool setOption(const string option, const string value, Mode m);
    bool setOptions(const EntryArg &arg, Mode m);

    bool Set(Mode m);

private:
    EntryCom comment;
    EntryArg argument;
    bool dirtyflag;

};

class ModulesConf {

public:
    typedef list<string> ModulesConfIndex;
    typedef map<const string, ModuleEntry> ModuleEntryMap;
    typedef map<const string, ModuleEntryMap> ModulesConfMap;

    ModulesConf(const string &fname);
    ~ModulesConf();

    ModulesConfMap getDirectives();
    ModuleEntryMap getModules(const string directive);
    ModuleEntry::EntryArg getOptions(const string module);
    string getOptionsAsString (const string module);
    string getOption(const string module, const string option);
    string getArgument(const string directive, const string module);
    string getComment(const string directive, const string module);

    bool setOption(const string module, const string option, const string value, ModuleEntry::Mode m);
    bool setOptions(const string module, const ModuleEntry::EntryArg arg, ModuleEntry::Mode m);
    bool setArgument(const string directive, const string module, const string arg, ModuleEntry::Mode m);
    bool setComment(const string directive, const string module, const string arg, ModuleEntry::Mode m);

    bool removeEntry(const string directive, const string module);

    bool writeFile(const string fname = "");

private:
    string file_name;
    ModulesConfMap modules_conf_map;
    ModulesConfIndex modules_conf_index;

    bool modified;              // was the stucture modified from ycp

    struct ModuleLine {
        string directive;
        string module;
        string argument;
        ModuleEntry::EntryArg options;
        string comment;
    };

    typedef time_t TimeStamp;
    TimeStamp getTimeStamp(const string &fname);

    TimeStamp time_stamp;

    bool isDirective(const string directive) const;
    bool isModule(const string directive, const string module);
    bool isOption(const string module, const string option);

    bool updateIfModified();
    bool updateTimeStamp();
    bool updateIndex(const string directive, const string module);
    bool parseLine(const string &line, ModuleLine &l) const;
    bool parseFile(const string &file_name, ModuleEntry::Mode m, const bool with_comment = true);

};


#endif /* ModulesConf_h */