TextInterfaceParser.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2003-2013 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/psrchive/Util/units/TextInterfaceParser.h
 
#ifndef __TextInterfaceParser_h
#define __TextInterfaceParser_h
 
#include "TextInterfaceValue.h"
 
#include "Alias.h"
#include "Error.h"
#include "tostring.h"
 
// #define _DEBUG 1
 
#ifdef _DEBUG
#include <iostream>
#endif
 
namespace TextInterface
{

  class Parser : public Reference::Able
  {
 
  public:

    Parser ();

    ~Parser ();

    std::string get_value (const std::string& name) const;

    std::string get_name_value (std::string& name) const;

    void set_value (const std::string& name, const std::string& value);

    Value* find (const std::string& name, bool throw_exception = true) const;

    bool found (const std::string& name) const;

    bool found (const std::string& prefix, const std::string& name) const;

    virtual void setup (const Value*) { }

    unsigned get_nvalue () const;

    std::string get_name (unsigned) const;

    std::string get_value (unsigned) const;

    std::string get_description (unsigned) const;

    virtual std::string process (const std::string& command);
    
    virtual std::string process (const std::vector<std::string>& commands);

    virtual std::string help (bool show_default_values = false,
                              bool show_header = false,
                              const char* indent = 0);

    virtual std::string get_interface_name () const { return ""; }

    virtual std::string get_interface_description () const { return ""; }

    void set_indentation (const std::string& indent) { indentation = indent; }
    std::string get_indentation () const { return indentation; }

    void set_delimiter (const std::string&);
    std::string get_delimiter () const { return delimiter; }

    void set_prefix_name (bool flag) { prefix_name = flag; }

    void set_aliases (const Alias* alias) { aliases = alias; }


    void insert (Parser*);


    void insert (const std::string& prefix, Parser*);

    void clean ();
 
  protected:

    std::string indentation;

    std::string delimiter;

    bool alphabetical;

    bool import_filter;

    bool prefix_name;

    Reference::To<const Alias> aliases;

    void add_value (Value* value);

    void remove (const std::string& name);

    void clean_invalid ();

    std::vector< Reference::To<Value> > values;

    std::vector< Reference::To<Parser> > inserted;
  };

  bool matches (const std::string& name,
                const std::string& prefix, const Value* value);
 
}
 
#endif