---

more/io/config_file.h

Go to the documentation of this file.

//  Copyright (C) 2002  Petter Urkedal (petter.urkedal@matfys.lth.se)
//
//  This file 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 file 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, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//  As a special exception, you may use this file as part of a free
//  software library without restriction.  Specifically, if other files
//  instantiate templates or use macros or inline functions from this
//  file, or you compile this file and link it with other files to
//  produce an executable, this file does not by itself cause the
//  resulting executable to be covered by the GNU General Public
//  License.  This exception does not however invalidate any other
//  reasons why the executable file might be covered by the GNU General
//  Public License.
//
//  $Id: config_file.h,v 1.1 2002/05/30 18:01:37 petter_urkedal Exp $

#ifndef MORE_IO_CONFIG_FILE_H
#define MORE_IO_CONFIG_FILE_H

#include <more/gen/ntree.h>

namespace more {
namespace io {

  /** The content of a configuration file is here represented as a
   ** tree of strings with a special interpretation.  A configuration
   ** file usually consists of a sequence of (key, value) assignments.
   ** Some configuration files also have sections and subsections.
   ** The respresentation is as follows.  A branch which has
   ** sub-branches is a section named by the node value.  If the
   ** branch has no sub-branches, it is an assignment.  The node value
   ** of the branch is the key and the leaves are its values.  The
   ** tree root is an anonymous section (its node value is an empty
   ** string).  Empty sections, other than the root, invalidates the
   ** tree, and must be removed by the parser or filled with a dummy
   ** assignment like '' = ''. */
  typedef gen::ntree<std::string> config_tree;

  /** True iff the \a t configuration subtree is a value (leaf). */
  inline bool
  is_config_value(config_tree const& t)
  {
      return t.branches().empty();
  }

  /** True iff the \a t configuration subtree is an assignment (branch
   ** with only leaves). */
  inline bool
  is_config_assignment(config_tree const& t)
  {
      return !t.branches().empty()
          && t.branches().begin()->branches().empty();
  }

  /** True iff the \a t configuration subtree is a section. */
  inline bool
  is_config_section(config_tree const& t)
  {
      return !t.branches().empty()
          && !t.branches().begin()->branches().empty();
  }

  /** True if \a t is a valid configuration tree.  Config file parsers
   ** should return valid configuration trees, so this is mostly
   ** useful for debugging parsers.  */
  bool is_valid_config_tree(config_tree const& t);

  // --- config_file_simple.cc ---

  /** Read config file in key-space-value-newline format.  The
   ** top-level branches are appended to \a t_out. */
  void read_config_ksvn(config_tree& t_out, std::string const& file_name);

  /** Read config file in key-equal-value-newline format.  The
   ** top-level branches are appended to \a t_out. */
  void read_config_kevn(config_tree& t_out, std::string const& file_name);

}} // more::io

#endif

---