AttributeTree.h

Go to the documentation of this file.

// this is a -*- C++ -*- file

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#ifndef ICL_CORE_CONFIG_ATTRIBUTE_TREE_H_INCLUDED
#define ICL_CORE_CONFIG_ATTRIBUTE_TREE_H_INCLUDED

#include <fstream>
#include <string>

#include "icl_core/BaseTypes.h"
#include "icl_core_config/ImportExport.h"

#ifdef _IC_BUILDER_DEPRECATED_STYLE_
# include "icl_core/Deprecate.h"
#endif

namespace icl_core {
namespace config {

class AttributeTree;

class FilePath
{
public:
  FilePath(const char *filename = "")
  {
    init(filename);
  }
  FilePath(const icl_core::String& filename)
  {
    init(filename.c_str());
  }

  ~FilePath()
  { }

  icl_core::String path() const
  {
    return icl_core::String(m_file, 0, m_file_path_name_split);
  }

  icl_core::String name() const
  {
    return icl_core::String(m_file, m_file_path_name_split, icl_core::String::npos);
  }

  icl_core::String absoluteName() const
  {
    return m_file;
  }

  icl_core::String currentDir() const
  {
    return m_pwd;
  }

  icl_core::String extension() const
  {
    return icl_core::String(m_file, m_file_name_extension_split, icl_core::String::npos);
  }

  icl_core::String absolutePath(const icl_core::String& filename) const;

  static bool isRelativePath(const icl_core::String& filename);

  bool isRelativePath() const
  {
    return FilePath::isRelativePath(m_file);
  }

  static icl_core::String normalizePath(const icl_core::String& filename);

  static icl_core::String exchangeSeparators(const icl_core::String& filename);

  static icl_core::String getEnvironment(const icl_core::String& var_name);

  static icl_core::String replaceEnvironment(const icl_core::String& filename);

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String Path() const ICL_CORE_GCC_DEPRECATE_STYLE;
  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String Name() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String AbsoluteName() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String CurrentDir() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String Extension() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String AbsolutePath(const icl_core::String& filename) const
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE static bool IsRelativePath(const icl_core::String& filename)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool IsRelativePath() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE static icl_core::String NormalizePath(const icl_core::String& filename)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE static icl_core::String ExchangeSeparators(const icl_core::String& filename)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE static icl_core::String GetEnvironment(const icl_core::String& var_name)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE static icl_core::String ReplaceEnvironment(const icl_core::String& filename)
    ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

private:
  void init(const char *filename);

  icl_core::String m_pwd;
  icl_core::String m_file;
  icl_core::String::size_type m_file_path_name_split;
  icl_core::String::size_type m_file_name_extension_split;
};


class ICL_CORE_CONFIG_IMPORT_EXPORT SubTreeList
{
  friend class AttributeTree;

public:
  SubTreeList(AttributeTree *sub_tree = 0, SubTreeList *next = 0);
  ~SubTreeList();
  void copy(AttributeTree *parent);
  void unlinkParent();
  void unlink(AttributeTree *obsolete_tree);
  AttributeTree *subTree(const char *description);
  int contains();
  void printSubTree(std::ostream& out, int change_style_depth, char *upper_description);
  void printXmlSubTree(std::ostream& out, const std::string& upper_description);
  bool changed();
  AttributeTree *search(const char *description, const char *attribute);
  AttributeTree *next(AttributeTree *prev);
  void unmarkChanges();

  SubTreeList *revertOrder(SubTreeList *new_next = NULL);

  void newSubTreeList(AttributeTree *new_tree, AttributeTree *after);

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE SubTreeList *RevertOrder(SubTreeList *new_next = NULL)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void NewSubTreeList(AttributeTree *new_tree, AttributeTree *after)
    ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

private:
  // Forbid copying.
  SubTreeList(const SubTreeList&);
  SubTreeList& operator = (const SubTreeList&);

  SubTreeList *m_next;
  AttributeTree *m_sub_tree;
};

class ICL_CORE_CONFIG_IMPORT_EXPORT AttributeTree
{
  friend class SubTreeList;

public:
  enum
  {
    eOK,              
    eEMPTY_TREE,      
    eFILE_SAVE_ERROR, 
    eFILE_LOAD_ERROR  
  };
  AttributeTree(const char *description = 0, AttributeTree *parent = 0);

  AttributeTree(const AttributeTree& other);

  AttributeTree(const AttributeTree& other, AttributeTree *parent);

  ~AttributeTree();

  void unlink();

  void unlinkSub();

  // inline AttributeTree *getSubTree(const char *description)
  // { return getOrCreateSubTree()->setAttribute(description, 0); }

  AttributeTree *setAttribute(const char *description, const char *attribute);

  AttributeTree *setAttribute(const char *description, const char *subdescription, const char *attribute);

  // inline AttributeTree *setSubAttribute(const char *description, const char *attribute)
  // { return setAttribute(m_this_description, description, attribute); }

  char *getAttribute()
  {
    return m_this_attribute;
  }

  char *getAttribute(const char *description, const char *default_attribute = 0,
                     AttributeTree **subtree = 0);

  char *getOrSetDefault(const char *description, const char *default_attribute);

  int save(const char *filename, int change_style_depth = 3, bool unmark_changes = true);

  int load(const char *filename, bool unmark_changes = true, bool process_include = true,
           bool load_comments = false, bool preserve_order = false);

  int get(std::istream &in, bool process_include = true, bool load_comments = false,
          const FilePath *file_path = NULL);

  char *newSubNodeDescription(const char *base_description = "");

  AttributeTree *addNewSubTree();

  void printSubTree(std::ostream &out, int change_style_depth = 3, const char *upper_description = 0);

  const char *getDescription() const
  {
    return m_this_description;
  }

  const char *attribute() const
  {
    return m_this_attribute;
  }

  void setDescription(const char *description);

  void setAttribute(const char *attribute);

  void setComment(const char *comment);

  AttributeTree *subTree(const char *description);

  AttributeTree *getSubTree(const char *description);

  AttributeTree *firstSubTree()
  {
    if (m_subtree_list)
    {
      return m_subtree_list->m_sub_tree;
    }
    else
    {
      return NULL;
    }
  }

  AttributeTree *nextSubTree(AttributeTree *subtree)
  {
    if (m_subtree_list)
    {
      return m_subtree_list->next(subtree);
    }
    else
    {
      return NULL;
    }
  }

  AttributeTree *parentTree()
  {
    return m_parent;
  }

  AttributeTree *addSubTree(AttributeTree *subtree)
  {
    return addSubTree(subtree, NULL);
  }

  AttributeTree *addNextTree(AttributeTree *nexttree)
  {
    if (m_parent)
    {
      return m_parent->addSubTree(nexttree, this);
    }
    else
    {
      return NULL;
    }
  }

  AttributeTree *search(const char *description, const char *attribute);

  bool isAttribute(const char *description, const char *attribute = 0);

  bool changed();

  void unmarkChanges();

  int contains();

  AttributeTree *parent()
  {
    return m_parent;
  }

  AttributeTree *root()
  {
    AttributeTree *at = this;
    for (; at->m_parent; at = at->m_parent) {}
    return at;
  }

  const char *comment();

  bool hasComment()
  {
    return commentAttributeTree() != NULL;
  }

  bool isComment();

  bool hasMultilineComment();

  bool isMultilineComment();

  AttributeTree *commentAttributeTree();

  void appendAttribute(const char *attribute, const char *separator = "")
  {
    appendString(m_this_attribute, attribute, separator);
  }

  void appendDescription(const char *description, const char *separator = "")
  {
    appendString(m_this_description, description, separator);
  }

  void revertOrder()
  {
    if (m_subtree_list)
    {
      m_subtree_list = m_subtree_list->revertOrder();
    }
  }

  static const char *m_file_path_str;

  const char *getFilePath()
  {
    const char *ret = root()->getSpecialAttribute(m_file_path_str);
    if (!ret)
    {
      ret = "";
    }
    return ret;
  }

  static const char *m_file_name_str;

  const char *fileName()
  {
    const char *ret = root()->getSpecialAttribute(m_file_name_str);
    if (!ret)
    {
      ret = "";
    }
    return ret;
  }

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE void Unlink() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void UnlinkSub() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE AttributeTree *SetAttribute(const char *description,
                                                          const char *attribute)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE AttributeTree *SetAttribute(const char *description,
                                                          const char *subdescription,
                                                          const char *attribute)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE char *GetAttribute() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE char *GetAttribute(const char *description,
                                                 const char *default_attribute = 0,
                                                 AttributeTree **subtree = 0)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE char *GetOrSetDefault(const char *description,
                                                    const char *default_attribute)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE int Save(const char *filename, int change_style_depth = 3,
                                       bool unmark_changes = true)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE int Load(const char *filename, bool unmark_changes = true,
                                       bool process_include = true,
                                       bool load_comments = false,
                                       bool preserve_order = false)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE int Get(std::istream &in, bool process_include = true,
                                      bool load_comments = false,
                                      const FilePath *file_path = NULL)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE char *NewSubNodeDescription(const char *base_description = "")
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE AttributeTree *AddNewSubTree() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void PrintSubTree(std::ostream &out,
                                                int change_style_depth = 3,
                                                const char *upper_description = 0)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE const char *Description() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE const char *Attribute() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void SetDescription(const char *description)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void SetAttribute(const char *attribute) ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void SetComment(const char *comment) ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE AttributeTree *SubTree(const char *description)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE AttributeTree *GetSubTree(const char *description)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE AttributeTree *FirstSubTree() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE AttributeTree *NextSubTree(AttributeTree *subtree)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE AttributeTree *ParentTree() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE AttributeTree *AddSubTree(AttributeTree *subtree)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE AttributeTree *AddNextTree(AttributeTree *nexttree)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE AttributeTree *Search(const char *description, const char *attribute)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool IsAttribute(const char *description, const char *attribute = 0)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool Changed() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void UnmarkChanges() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE int Contains() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE AttributeTree *Parent() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE AttributeTree *Root() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE const char *Comment() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool HasComment() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool IsComment() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool HasMultilineComment() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool IsMultilineComment() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE AttributeTree *CommentAttributeTree() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void AppendAttribute(const char *attribute, const char *separator = "")
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void AppendDescription(const char *description, const char *separator = "")
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void RevertOrder() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE const char *GetFilePath() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE const char *FileName() ICL_CORE_GCC_DEPRECATE_STYLE;

#endif


private:
  void split(char *&description, char *&sub_description);
  void appendString(char * &dest, const char *src, const char *separator);

  // Forbid copying.
  AttributeTree& operator = (const AttributeTree&);

  char *getSpecialAttribute(const char *description, AttributeTree **subtree = NULL);

  AttributeTree *addSubTree(AttributeTree *subtree, AttributeTree *after_node);

  AttributeTree *m_parent;
  SubTreeList *m_subtree_list;

  char *m_this_description;
  char *m_this_attribute;

  bool m_changed;
};

}
}

#endif