Skip to Navigation

User login

Username: *

Password: *

• Request new password

• jigdo
• Development
• Debian jigdo mini-HOWTO

Home › jigdo › Development › jigdo API

jigdo API

Last update by Admin on 2010-05-23

• Namespaces
• Class hierarchy
• Class list
• File list
• Namespace Members
• Class Members
• File Members

util/configfile.hh

Go to the documentation of this file.

/* $Id: configfile.hh,v 1.2 2003/09/27 21:31:04 atterer Exp $ -*- C++ -*-
  __   _
  |_) /|  Copyright (C) 2001-2002  |  richard@
  | \/¯|  Richard Atterer          |  atterer.net
  ¯ '` ¯
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License, version 2. See
  the file COPYING for details.

*/
#ifndef CONFIGFILE_HH
#define CONFIGFILE_HH

#include <iosfwd>
#include <list>
#include <string>

#include <debug.hh>
//______________________________________________________________________

class ConfigFile {
public:
  class ProgressReporter;
  class iterator;
  inline ConfigFile(ProgressReporter& pr = noReport);
  ~ConfigFile();

  void rescan(bool printErrors = false);

  void setReporter(ProgressReporter& pr) { reporter = &pr; }

  istream& get(istream& s);
  ostream& put(ostream& s) const;
  //______________________________

  inline iterator firstSection() { return iterator(*firstSect()); }
  inline iterator firstSection(const string& sectName);

  typedef string& reference;
  typedef const string& const_reference;

  size_t size() const { return lineCount; }
  bool empty() const { return size() == 0; }

  inline iterator begin();
  //inline const_iterator begin() const;
  inline iterator end();
  //inline const_iterator end() const;
  inline reference front();
  //inline const_reference front() const;
  inline reference back();
  //inline const_reference back() const;

  // Return iterator to first such line in section, or end()
  iterator find(const string& sectName, const string& line);

  // Insert empty line before pos
  inline iterator insert(iterator pos);
  // Insert s before pos
  inline iterator insert(iterator pos, const_reference s);
  inline iterator insert(iterator pos, const char* s);
  // Delete line at pos from list; pos becomes invalid
  inline iterator erase(iterator pos);
  //inline iterator erase(iterator first, iterator last);
  // Add line at end of list
  inline void push_back(); // Empty line
  inline void push_back(const string& s);
  inline void push_back(const char* s);
  //______________________________

  static inline bool advanceWhitespace(string::const_iterator& x,
                                       const string::const_iterator& end);
  static inline bool advanceWhitespace(string::iterator& x,
                                       const string::const_iterator& end);
  static inline bool isWhitespace(char x) { return x == ' ' || x == '\t'; }

  template<class Container> // E.g. vector<string>; anything with push_back()
  static void split(Container& out, const string& s, size_t offset = 0);
  static string& quote(string& s);

private:
  struct Line {
    Line() : prev(), next(), nextSect(0), text() { }
    Line(const string& s) : prev(), next(), nextSect(0), text(s) { }
    Line(const char* s) : prev(), next(), nextSect(0), text(s) { }
    // Returns true if *this is the end() element
    bool isEnd() const { return nextSect != 0 && text.empty(); }
    Line* prev;
    Line* next;
    // Linked ring of [section] lines, or null for non-section lines
    Line* nextSect;
    string text;
  };
  ProgressReporter* reporter;
  // Disallow copying - copy ctor is never defined
  inline ConfigFile(const ConfigFile&);
  /* Dummy element for end(). Its "next" ptr points to the first, its
     "prev" ptr to the last element, i.e. doubly linked ring of Line
     objects. Its nextSect is ptr to linked ring of [section] lines,
     or ptr to endElem itself if no sections present. */
  Line endElem;
  size_t lineCount;
  Line*& firstSect() { return endElem.nextSect; }

  static bool split1Word(string* word, const string& s,
                         string::const_iterator& e);

  static ProgressReporter noReport;

public:
  //______________________________

  class iterator {
    friend class ConfigFile;
  public:
    iterator() { }
    iterator(const iterator& i) : p(i.p) { }
    iterator& operator=(const iterator& i) { p = i.p; return *this; }
    // Default dtor
    reference operator*() const { return p->text; }
    reference operator*() { return p->text; }
    string* operator->() const { return &p->text; }
    string* operator->() { return &p->text; }
    iterator& operator++() { p = p->next; return *this; }
    iterator& operator--() { p = p->prev; return *this; }
    bool operator==(const iterator i) const { return p == i.p; }
    bool operator!=(const iterator i) const { return p != i.p; }
    bool isSection() const { return p->nextSect != 0; }
    bool isSection(const string& sectName) const;
    inline iterator& nextSection();
    iterator& nextSection(const string& sectName);
    inline bool nextLabel();
    inline bool prevLabel();
    size_t nextLabel(const string& labelName);
    bool setLabelOffsets(size_t& begin, size_t& end, size_t& value);
  private:
    iterator(Line& l) : p(&l) { }
    Line*& nextSect() { return p->nextSect; }
    Line* p;
  };
  //______________________________

  class Find {
  public:
    // Default copy ctor, dtor
    Find(ConfigFile* c, const string& sectName, const string& labelName,
         const iterator i, size_t* offset = 0);
    Find(ConfigFile* c, const string& sectName, const string& labelName,
         size_t* offset = 0);
    size_t next();
    iterator section() const { return sectionIter; }
    iterator label() const { return labelIter; }
    bool finished() const { return labelIter == configFile->end(); }
  private:
    ConfigFile* configFile;
    const string& sectionStr;
    const string& labelStr;
    iterator sectionIter; // For section line
    iterator labelIter; // For label line
    bool rightSection;
  };
  // TODO: Find_const, which works on a const ConfigFile...
};
//______________________________________________________________________

class ConfigFile::ProgressReporter {
public:
  virtual ~ProgressReporter() { }
  virtual void error(const string& message, const size_t lineNr = 0);
  virtual void info(const string& message, const size_t lineNr = 0);
};
//______________________________________________________________________

ConfigFile::ConfigFile(ProgressReporter& pr)
    : reporter(&pr), endElem(), lineCount(0) {
  endElem.prev = &endElem;
  endElem.next = &endElem;
  endElem.nextSect = &endElem;
}

bool ConfigFile::advanceWhitespace(string::const_iterator& x,
                                   const string::const_iterator& end) {
  while (true) {
    if (x == end || *x == '#') return true;
    if (*x != ' ' && *x != '\t') return false;
    ++x;
  }
}
bool ConfigFile::advanceWhitespace(string::iterator& x,
                                   const string::const_iterator& end) {
  while (true) {
    if (x == end || *x == '#') return true;
    if (*x != ' ' && *x != '\t') return false;
    ++x;
  }
}

ConfigFile::iterator& ConfigFile::iterator::nextSection() {
  // p automatically ends up pointing to end()
  if (isSection()) {
    p = p->nextSect;
  } else {
    do p = p->next; while (!isSection());
  }
  return *this;
}

bool ConfigFile::iterator::nextLabel() {
  while (true) {
    ++*this;
    if (isSection()) return false;
    // Next line is superfluous cos endElem.isSection() == true
    //if (p->isEnd()) return false;

    /* Skip any empty line. If there is *any* character on this line,
       it must be a label line; it cannot be a section line because
       isSection() == false above */
    string::const_iterator x = p->text.begin();
    if (!advanceWhitespace(x, p->text.end())) return true;
  }
}

bool ConfigFile::iterator::prevLabel() {
  while (true) {
    --*this;
    if (isSection()) return false;
    string::const_iterator x = p->text.begin();
    if (!advanceWhitespace(x, p->text.end())) return true;
  }
}

ConfigFile::iterator ConfigFile::firstSection(const string& sectName) {
  iterator i = end();
  i.nextSection(sectName);
  return i;
}

ConfigFile::iterator ConfigFile::begin() { return iterator(*endElem.next); }
ConfigFile::iterator ConfigFile::end() { return iterator(endElem); }
ConfigFile::reference ConfigFile::front() { return endElem.next->text; }
ConfigFile::reference ConfigFile::back() { return endElem.prev->text; }

ConfigFile::iterator ConfigFile::insert(iterator pos) {
  Line* x = new Line();
  x->prev = pos.p->prev; x->next = pos.p;
  pos.p->prev->next = x; pos.p->prev = x;
  ++lineCount;
  return pos;
}
ConfigFile::iterator ConfigFile::insert(iterator pos, const_reference s) {
  Line* x = new Line(s);
  x->prev = pos.p->prev; x->next = pos.p;
  pos.p->prev->next = x; pos.p->prev = x;
  ++lineCount;
  return pos;
}
ConfigFile::iterator ConfigFile::insert(iterator pos, const char* s) {
  Line* x = new Line(s);
  x->prev = pos.p->prev; x->next = pos.p;
  pos.p->prev->next = x; pos.p->prev = x;
  ++lineCount;
  return pos;
}
ConfigFile::iterator ConfigFile::erase(iterator pos) {
  Paranoid(pos.p != 0); // Don't erase an element twice
  Paranoid(!pos.p->isEnd()); // Don't c.erase(c.end())
  pos.p->next->prev = pos.p->prev;
  pos.p->prev->next = pos.p->next;
  --lineCount;
  delete pos.p;
  pos.p = 0;
  return pos;
}
void ConfigFile::push_back() {
  insert(iterator(endElem));
}
void ConfigFile::push_back(const string& s) {
  insert(iterator(endElem));
  back() = s;
}
void ConfigFile::push_back(const char* s) {
  insert(iterator(endElem));
  back() = s;
}
//______________________________________________________________________

inline ostream& operator<<(ostream& s, const ConfigFile& c) {
  return c.put(s);
}
inline istream& operator>>(istream& s, ConfigFile& c) {
  return c.get(s);
}
//______________________________________________________________________

template<class Container>
void ConfigFile::split(Container& out, const string& s, size_t offset) {
  string word;
  string::const_iterator e = s.begin() + offset;
  while (split1Word(&word, s, e)) {
    out.push_back(string());
    swap(word, out.back());
  }
}

#endif

---

• Photography
• Software
• jigdo
• Research
• About

© Copyright 2014 Richard Atterer

 Top of page  •  Home  •  Sitemap  •  Contact  •  About