lib/configuration/item.h

Go to the documentation of this file.

//
// nis-util - NIS Administration Utilities
// Copyright (C) 2012 Peter Miller
//
// 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.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program. If not, see <http://www.gnu.org/licenses/>.
//

#ifndef LIB_CONFIGURATION_ITEM_H
#define LIB_CONFIGURATION_ITEM_H

#include <boost/shared_ptr.hpp>

#include <lib/source_location.h>

#define ITEM_WARNING "warning"
#define ITEM_NAME_LENGTH_MAXIMUM "name-length-maximum"

class configuration_item
{
public:
    typedef boost::shared_ptr<configuration_item> pointer;

    virtual ~configuration_item();

    enum level_t
    {
        level_builtin,

        level_etc_nis_util_conf,

        level_home_nis_util_rc,

        level_nis_util_env,

        level_nis_util_prog_env,

        level_command_line_file,

        level_command_line_option
    };

    static const char *level_name(level_t value);

    virtual rcstring get_string_value(void) const = 0;

    virtual bool get_bool_value(void) const = 0;

    virtual long get_long_value(void) const = 0;

    const source_location &get_source_location(void) const { return locn; }

    level_t get_level(void) const { return level; }

    rcstring get_name(void) const { return name; }

    void print(void) const;

protected:
    configuration_item(const source_location &locn, level_t level,
        const rcstring &name);

private:
    source_location locn;

    level_t level;

    rcstring name;
};

// vim: set ts=8 sw=4 et :
#endif // LIB_CONFIGURATION_ITEM_H