TextInterfaceEmbed.h

//-*-C++-*-
 
/***************************************************************************
 *
 *   Copyright (C) 2013 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/Util/units/TextInterfaceEmbed.h
 
#ifndef __TextInterfaceEmbed_h
#define __TextInterfaceEmbed_h
 
#include "TextInterfaceAttribute.h"
#include "separate.h"
 
namespace TextInterface
{

  template<class C, class Type, class Get, class Set>
  class OptionalInterface : public AttributeGetSet<C,Type,Get,Set>
  {
 
  public:
    
    OptionalInterface (const std::string& t, Get g, Set s)
      : AttributeGetSet<C,Type,Get,Set> (t,g,s)
    {
#if _DEBUG
      std::cerr << "OptionalInterface name=" << t << std::endl;
#endif
    }

    std::string get_name () const
    { return AttributeGetSet<C,Type,Get,Set>::get_name() + "[:@]"; }

    std::string get_value (const C* ptr) const;

    void set_value (C* ptr, const std::string& value);

    bool matches (const std::string& name) const;
 
    void set_modifiers (const std::string&) const;
    void reset_modifiers () const;
 
  protected:
 
    virtual Parser* get_parser (const C* ptr) const = 0;

    mutable Reference::To<Value> value;
    mutable bool help = false;
  };
 


  template<class C, class Get>
  class GetParserPolicy
  {
  public:
    Parser* operator () (const C* ptr, Get func) const
    {
      return func (const_cast<C*>(ptr));
    }
  };
 
  template<class C, class P>
  class GetParserPolicy<C, Parser* (P::*)()>
  {
  public:
    Parser* operator () (const C* ptr, Parser* (P::*get)()) const
    {
      return (const_cast<C*>(ptr)->*get)();
    }
  };
 
  template<class C>
  class GetParserPolicy<C, Parser* (C*)>
  {
  public:
    Parser* operator () (const C* ptr, Parser* (*func)(C*)) const
    {
      return func (const_cast<C*>(ptr));
    }
  };
 
  template<class C, class Type, class Get, class Set, class GetParser>
  class DirectInterface : public OptionalInterface<C,Type,Get,Set>
  {
 
    GetParserPolicy<C,GetParser> get_parser_policy;
 
  public:
    
    DirectInterface (const std::string& t, Get g, Set s, GetParser p)
      : OptionalInterface<C,Type,Get,Set> (t,g,s), get_parser_method (p) {  }

    Attribute<C>* clone () const
    { return new DirectInterface(*this); }
 
  protected:

    GetParser get_parser_method;
 
    Parser* get_parser (const C* ptr) const try
    { 
      return get_parser_policy (ptr, get_parser_method);
    }
    catch (Error& error)
    {
      throw error += "DirectInterface::get_parser";
    }
  };
 
  template<class C, class Type, class Get, class Set, class GetParser>
  class IndirectInterface : public OptionalInterface<C,Type,Get,Set>
  {
 
  public:
    
    IndirectInterface (const std::string& t, Get g, Set s, GetParser p)
      : OptionalInterface<C,Type,Get,Set> (t,g,s), get_parser_method (p) {  }

    Attribute<C>* clone () const
    { return new IndirectInterface(*this); }
 
  protected:

    GetParser get_parser_method;
 
    Parser* get_parser (const C* ptr) const try
    { 
      Type tptr = (const_cast<C*>(ptr)->*(this->get))();
      return (tptr->*get_parser_method)();
    }
    catch (Error& error)
    {
      throw error += "IndirectInterface::get_parser";
    }
  };
 
  template<class C, class Type>
  class EmbedAllocator 
  {
  public:
    template<class Get, class Set, class GetParser>
    OptionalInterface<C,Type,Get,Set>* 
    direct (const std::string& n, Get g, Set s, GetParser p)
    {
      return new DirectInterface<C,Type,Get,Set,GetParser> (n,g,s,p);
    }

    template<class Get, class Set, class GetParser>
    OptionalInterface<C,Type,Get,Set>* 
    indirect (const std::string& n, Get g, Set s, GetParser p)
    {
      return new IndirectInterface<C,Type,Get,Set,GetParser> (n,g,s,p);
    }
  };


  template<class V, class Get, class Size>
  class VectorOfInterfaces : public Attribute<V>
  {
 
  public:
    
    VectorOfInterfaces (const std::string& p, Get g, Size s)
      { prefix = p; get = g; size = s; }

    VectorOfInterfaces (const VectorOfInterfaces& copy)
      { get=copy.get; size=copy.size; prefix=copy.prefix; }

    Attribute<V>* clone () const
      { return new VectorOfInterfaces(*this); }

    std::string get_name () const
    { return prefix + "*:@"; }

    std::string get_description () const
    { return prefix + ":help for attribute list"; }

    std::string get_value (const V* ptr) const;

    void set_value (V* ptr, const std::string& value);

    void set_description (const std::string&) {}

    void set_detailed_description (const std::string&) {}

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

    void set_modifiers (const std::string& mod) const
    { modifiers = mod; }

    void reset_modifiers () const
    { modifiers.erase(); }
 
  protected:

    Get get;

    Size size;

    std::string prefix;

    mutable std::string range;

    mutable std::string remainder;

    mutable std::string modifiers;
  };

  template<class C>
    class Embed
  {
  public:
    template <class G, class S>
    VectorOfInterfaces<C,G,S>* operator() (const std::string& name, G g, S s)
    {
      return new VectorOfInterfaces<C,G,S>(name, g, s);
    }
  };


  template<class M, class K, class Get>
  class MapOfInterfaces : public Attribute<M>
  {
 
  public:
    
    MapOfInterfaces (const std::string& pre, Get g)
      { prefix = pre; get = g; }

    MapOfInterfaces (const MapOfInterfaces& copy)
      { prefix=copy.prefix; get=copy.get;  }

    
    Attribute<M>* clone () const
      { return new MapOfInterfaces(*this); }

    std::string get_name () const
    { return prefix + "?:@"; }

    std::string get_description () const
    { return prefix + ":help for attribute list"; }

    std::string get_value (const M* ptr) const;

    void set_value (M* ptr, const std::string& value);

    void set_description (const std::string&) {}

    void set_detailed_description (const std::string&) {}

    bool matches (const std::string& name) const;
 
  protected:

    Get get;

    std::string prefix;

    mutable std::string range;

    mutable std::string remainder;

    void get_indeces (std::vector<K>& keys,
                      const std::string& param) const;
 
  };
 
}
 
template<class C, class T, class G, class S> 
std::string
TextInterface::OptionalInterface<C,T,G,S>::get_value (const C* ptr) const try
{
  if (help)
  {
    Reference::To<Parser> parser = get_parser(ptr);
    if (parser)
      return "\n" + parser->help();
    else
      return "no text parser available";
  }
 
  if (value)
    return value->get_value();
 
  return AttributeGetSet<C,T,G,S>::get_value (ptr);
}
catch (Error& error)
{
  return "-";
}
 
template<class C, class T, class G, class S>
void TextInterface::OptionalInterface<C,T,G,S>::set_value (C* ptr,
                                                          const std::string& val) try
{
  if (value)
    value->set_value (val);
  else
    AttributeGetSet<C,T,G,S>::set_value (ptr, val);
}
catch (Error& error)
{
  throw error += "TextInterface::OptionalInterface::set_value";
}
 
template<class C, class T, class G, class S>
bool TextInterface::OptionalInterface<C,T,G,S>::matches
  (const std::string& text) const try
{
#ifdef _DEBUG
  std::cerr << "TextInterface::OptionalInterface::matches"
    " text='" << text << "'" << std::endl;
#endif
 
  value = 0;
  help = false;
 
  if (text == this->name)
    return true;
 
  if (text == this->name + "[:@]")
    return true;
 
  std::string range;
  std::string remainder;
  if (!match (this->name, text, &range, &remainder))
    return false;
 
#ifdef _DEBUG
  std::cerr << "TextInterface::OptionalInterface::matches"
    " remainder='" << remainder << "'" << std::endl;
#endif
 
  if (remainder == "help")
  {
    help = true;
    return true;
  }
 
  if (!this->instance)
  {
#ifdef _DEBUG
  std::cerr << "TextInterface::OptionalInterface::matches"
    " no instance" << std::endl;
#endif
    return false;
  }
 
#ifdef _DEBUG
  std::cerr << "TextInterface::OptionalInterface::matches"
    " getting Parser" << std::endl;
#endif
 
  Reference::To<Parser> parser;
 
  try
  {
    parser = get_parser(this->instance);
  }
  catch (Error&)
  {
    return false;
  }
 
  if (!parser)
    return false;
 
#ifdef _DEBUG
  std::cerr << "TextInterface::OptionalInterface::matches"
    " got Parser" << std::endl;
#endif
 
  bool throw_exception = false;
  value = parser->find (remainder, throw_exception);
 
  if (!value)
  {
#ifdef _DEBUG
  std::cerr << "TextInterface::OptionalInterface::matches"
    " Parser::find(" << remainder << ") returns false" << std::endl;
#endif
    return false;
  }
 
#ifdef _DEBUG
  std::cerr << "TextInterface::OptionalInterface::matches"
    " Parser::find(" << remainder << ") returns true" << std::endl;
#endif
 
  return true;
}
catch (Error& error)
{
  throw error += "TextInterface::OptionalInterface::matches";
}
 
template<class C, class T, class G, class S>
void TextInterface::OptionalInterface<C,T,G,S>::set_modifiers (const std::string& modifiers) const try
{
  if (value)
  {
#ifdef _DEBUG
    std::cerr << "TextInterface::OptionalInterface"
      " calling Value::set_modifiers (" << modifiers << ")" << std::endl;
#endif
    value->set_modifiers (modifiers);
  }
  else
  {
#ifdef _DEBUG
    std::cerr << "TextInterface::OptionalInterface"
      " calling AttributeGetSet<>::set_modifiers" << std::endl;
#endif
    AttributeGetSet<C,T,G,S>::set_modifiers (modifiers);
  }
}
catch (Error& error)
{
  throw error += "TextInterface::OptionalInterface::set_modifiers";
}
 
template<class C, class T, class G, class S>
void TextInterface::OptionalInterface<C,T,G,S>::reset_modifiers () const try
{
  if (value)
    value->reset_modifiers ();
  else
    AttributeGetSet<C,T,G,S>::reset_modifiers ();
}
catch (Error& error)
{
  throw error += "TextInterface::OptionalInterface::reset_modifiers";
}
 
 
 
 
 
 
 
 
template<class V, class G, class S> 
std::string
TextInterface::VectorOfInterfaces<V,G,S>::get_value (const V* ptr) const try
{
  std::vector<unsigned> ind;
  parse_indeces (ind, this->range, (ptr->*(this->size))());
  std::string result;
 
  if (!this->parent)
    throw Error (InvalidState, "VectorOfInterfaces["+prefix+"]", "no parent");
 
  for (unsigned i=0; i<ind.size(); i++)
  {
    // place a delimiter between elements
    if (i)
      result += this->parent->get_delimiter();
 
    // label the elements
    if (label_elements && ind.size() > 1)
      result += tostring(ind[i]) + ")";
 
    Reference::To<Parser> parser;
    parser = (const_cast<V*>(ptr)->*get)(ind[i])->get_interface();
 
    parser->set_delimiter( this->parent->get_delimiter() );
 
    if (remainder == "help")
      result += "\n" + parser->help();
    else
    {
      std::string pass_to_parser = remainder;
      if (modifiers.length() > 0)
        pass_to_parser += "%" + modifiers;
      result += parser->get_value (pass_to_parser);
    }
  }
 
  return result;
}
catch (Error& error)
{
  throw error += "TextInterface::VectorOfInterfaces::get_value";
}
 
template<class V, class G, class S>
void TextInterface::VectorOfInterfaces<V,G,S>::set_value (V* ptr,
                                                          const std::string& val) try
{
  std::vector<unsigned> ind;
  parse_indeces (ind, range, (ptr->*size)());
 
  for (unsigned i=0; i<ind.size(); i++)
  {
    Reference::To<Parser> parser = (ptr->*get)(ind[i])->get_interface();
    parser->set_value (remainder, val);
  }
}
catch (Error& error)
{
  throw error += "TextInterface::VectorOfInterfaces::set_value";
}
 
template<class C,class Get,class Size>
 bool TextInterface::VectorOfInterfaces<C,Get,Size>::matches
  (const std::string& name) const try
{
#ifdef _DEBUG
  std::cerr << "TextInterface::VectorOfInterfaces::matches" << std::endl;
#endif
 
  if (!match (prefix, name, &range, &remainder))
    return false;
 
  if (remainder == "@")
    return true;
 
  if (remainder == "help")
    return true;
 
  if (!this->instance)
    return false;
 
  std::vector<unsigned> ind;
  parse_indeces (ind, range, (this->instance->*size)());
 
  for (unsigned i=0; i<ind.size(); i++)
  {
    C* ptr = this->instance.ptr();
    Reference::To<Parser> parser = (ptr->*get)(ind[i])->get_interface();
    if (! parser->found (remainder))
      return false;
  }
  return true;
}
catch (Error& error)
{
  throw error += "TextInterface::VectorOfInterfaces::matches";
}
 
template<class M, class K, class G> 
std::string
TextInterface::MapOfInterfaces<M,K,G>::get_value (const M* ptr) const try
{
  std::vector<K> ind;
  get_indeces (ind, range);
  std::string result;
 
  if (!this->parent)
    throw Error (InvalidState, "MapOfInterfaces["+prefix+"]", "no parent");
 
  for (unsigned i=0; i<ind.size(); i++)
  {
    // place a delimiter between elements
    if (i)
      result += this->parent->get_delimiter();
 
    // label the elements
    if (label_elements && ind.size() > 1)
      result += tostring(ind[i]) + ")";
 
    Reference::To<Parser> parser = (const_cast<M*>(ptr)->*get)(ind[i])->get_interface();
    parser->set_delimiter( this->parent->get_delimiter() );
    result += parser->get_value (remainder);
  }
 
  return result;
}
catch (Error& error)
{
  throw error += "TextInterface::MapOfInterfaces::get_value";
}
 
template<class M, class K, class G>
void TextInterface::MapOfInterfaces<M,K,G>::set_value (M* ptr,
                                                    const std::string& val) try
{
  std::vector<K> ind;
  get_indeces (ind, range);
 
  for (unsigned i=0; i<ind.size(); i++)
  {
    Reference::To<Parser> parser = (ptr->*get)(ind[i])->get_interface();
    parser->set_value (remainder, val);
  }
}
catch (Error& error)
{
  throw error += "TextInterface::MapOfInterfaces::set_value";
}
 
template<class M, class K, class G>
void
TextInterface::MapOfInterfaces<M,K,G>::get_indeces (std::vector<K>& indeces,
                                                 const std::string& par) const try
{
#ifdef _DEBUG
  std::cerr << "MapOfInterfaces::get_indeces " << par << std::endl;
#endif
 
  std::string::size_type length = par.length();
 
  std::string range = par;
 
  if (prefix.length()) {
    if (par[0] != '[' || par[length-1] != ']')
      return;
    range = par.substr (1, length-2);
  }
  else if (par == "?")
    return;
 
  std::vector<std::string> key_str;
  separate (range, key_str, ", ");
 
  indeces.resize (key_str.size());
  for (unsigned i=0; i<key_str.size(); i++)
    indeces[i] = fromstring<K>(key_str[i]);
}
catch (Error& error)
{
  throw error += "TextInterface::MapOfInterfaces::get_indeces";
}
 
template<class M, class K, class G>
 bool TextInterface::MapOfInterfaces<M,K,G>::matches
  (const std::string& name) const try
{
#ifdef _DEBUG
  std::cerr << "TextInterface::MapOfInterfaces::matches" << std::endl;
#endif
 
  if (!match (prefix, name, &range, &remainder))
    return false;
 
  if (remainder == "@")
    return true;
 
  if (!this->instance)
    return false;
 
  std::vector<K> ind;
  get_indeces (ind, range);
 
  for (unsigned i=0; i<ind.size(); i++)
  {
    Reference::To<Parser> parser = (const_cast<M*>(this->instance)->*get)(ind[i])->get_interface();
    if (! parser->found (remainder))
      return false;
  }
  return true;
}
catch (Error& error)
{
  throw error += "TextInterface::MapOfInterfaces::matches";
}
 
#endif