gum::prm::o3prm::O3prmReader< GUM_SCALAR > Class Template Reference

This class read O3PRM files and creates the corresponding gum::prm::PRM. More...

#include <agrum/PRM/o3prm/O3prmReader.h>

Collaboration diagram for gum::prm::o3prm::O3prmReader< GUM_SCALAR >:

Public Member Functions
	O3prmReader ()
	O3prmReader (PRM< GUM_SCALAR > &prm)
	O3prmReader (const O3prmReader &src)
	O3prmReader (O3prmReader &&src)
	~O3prmReader ()
O3prmReader &	operator= (const O3prmReader &src)
O3prmReader &	operator= (O3prmReader &&src)
Size	readFile (const std::string &file, const std::string &module="")
	Read file and load its content using a PRMFactory. The package parameter set the file's content package. More...
Size	readString (const std::string &string)
	With readString method, you must set the current path to search from import yourself, using addClassPath. More...
void	parseStream (std::istream &input, std::ostream &output, std::string module="")
void	setClassPath (const std::string &class_path)
	This methods defines the list of paths to look for o3prm files. More...
void	addClassPath (const std::string &class_path)
	Add a list of paths to look for o3prm files. More...
gum::prm::PRM< GUM_SCALAR > *	prm ()
const gum::prm::PRM< GUM_SCALAR > *	prm () const
Size	errors () const
	publishing Errors API More...
Size	warnings () const
	of errors More...
const ErrorsContainer &	errorsContainer () const
	publishing Errors API More...
Idx	errLine (Idx i) const
	line of ith error or warning More...
Idx	errCol (Idx i) const
	col of ith error or warning More...
std::wstring	errFilename (Idx i) const
	filename of ith error or warning More...
bool	errIsError (Idx i) const
	type of ith error or warning More...
std::string	errMsg (Idx i) const
	message of ith error or warning More...
void	showElegantErrors (std::ostream &o=std::cerr) const
	send on std::cerr the list of errors More...
void	showElegantErrorsAndWarnings (std::ostream &o=std::cerr) const
	send on std::cerr the list of errors or warnings More...
void	showErrorCounts (std::ostream &o=std::cerr) const
	send on std::cerr the number of errors and the number of warnings More...

Detailed Description

template<typename GUM_SCALAR>
class gum::prm::o3prm::O3prmReader< GUM_SCALAR >

This class read O3PRM files and creates the corresponding gum::prm::PRM.

Template Parameters

GUM_SCALAR

The scalar type to use with the gum::prm::PRM.

Definition at line 68 of file O3prmReader.h.

Constructor & Destructor Documentation

O3prmReader() [1/4]

template<typename GUM_SCALAR >

INLINE gum::prm::o3prm::O3prmReader< GUM_SCALAR >::O3prmReader

(

)

Definition at line 140 of file O3prmReader_tpl.h.

                                                    :
          prm__(new PRM< GUM_SCALAR >()),
          o3_prm__(std::unique_ptr< O3PRM >(new O3PRM())) {
        GUM_CONSTRUCTOR(O3prmReader);
      }

O3prmReader() [2/4]

template<typename GUM_SCALAR>

INLINE gum::prm::o3prm::O3prmReader< GUM_SCALAR >::O3prmReader ( PRM< GUM_SCALAR > &  prm )

explicit

Definition at line 147 of file O3prmReader_tpl.h.

                                                                          :
          prm__(&prm), o3_prm__(std::unique_ptr< O3PRM >(new O3PRM())) {
        GUM_CONSTRUCTOR(O3prmReader);
      }

O3prmReader() [3/4]

template<typename GUM_SCALAR>

INLINE gum::prm::o3prm::O3prmReader< GUM_SCALAR >::O3prmReader

(

const O3prmReader< GUM_SCALAR > &

src

)

Definition at line 153 of file O3prmReader_tpl.h.

                                                                          :
          prm__(src.prm__),
          o3_prm__(std::unique_ptr< O3PRM >(new O3PRM(*(src.o3_prm__)))),
          class_path__(src.class_path__), imported__(src.imported__),
          errors__(src.errors__) {
        GUM_CONS_CPY(O3prmReader);
      }

O3prmReader() [4/4]

template<typename GUM_SCALAR>

INLINE gum::prm::o3prm::O3prmReader< GUM_SCALAR >::O3prmReader

(

O3prmReader< GUM_SCALAR > &&

src

)

Definition at line 162 of file O3prmReader_tpl.h.

                                                                     :
          prm__(std::move(src.prm__)), o3_prm__(std::move(src.o3_prm__)),
          class_path__(std::move(src.class_path__)),
          imported__(std::move(src.imported__)),
          errors__(std::move(src.errors__)) {
        GUM_CONS_CPY(O3prmReader);
      }

~O3prmReader()

template<typename GUM_SCALAR >

INLINE gum::prm::o3prm::O3prmReader< GUM_SCALAR >::~O3prmReader

(

)

Definition at line 171 of file O3prmReader_tpl.h.

                                                     {
        GUM_DESTRUCTOR(O3prmReader);
      }

Member Function Documentation

addClassPath()

template<typename GUM_SCALAR >

void gum::prm::o3prm::O3prmReader< GUM_SCALAR >::addClassPath

(

const std::string &

class_path

)

Add a list of paths to look for o3prm files.

Use / for path separator ! Even on Windows !

Parameters

class_path

A semicolon separated list of paths.

Definition at line 222 of file O3prmReader_tpl.h.

                                                                              {
        auto path = class_path;
        if (path[path.size() - 1] != '/') { path.append("/"); }
        auto dir = Directory(path);

        if (!dir.isValid()) {
          errors__.addException("could not resolve class path", path);
        } else {
          class_path__.push_back(std::move(path));
        }
      }

clean__()

template<typename GUM_SCALAR >

INLINE std::string gum::prm::o3prm::O3prmReader< GUM_SCALAR >::clean__ ( std::string  text ) const

private

Definition at line 37 of file O3prmReader_tpl.h.

                                                                    {
        // This could be way more faster with regex but there are not implemented
        // with gcc-4.8 !
        text = replace(text, "Syntax error", "Error");

        text = replace(text, "LABEL_OR_STAR_LIST", "declaration");

        text = replace(text, "ARRAY_REFERENCE_SLOT", "declaration");
        text = replace(text, "FLOAT_AS_LABEL", "declaration");
        text = replace(text, "FLOAT_OR_INT", "declaration");
        text = replace(text, "INTEGER_AS_FLOAT", "declaration");
        text = replace(text, "INTEGER_AS_LABEL", "declaration");
        text = replace(text, "INT_TYPE_DECLARATION", "declaration");
        text = replace(text, "LABEL_OR_INT", "declaration");
        text = replace(text, "LABEL_OR_STAR", "declaration");
        text = replace(text, "NAMED_CLASS_ELEMENT", "declaration");
        text = replace(text, "REAL_TYPE_DECLARATION", "declaration");

        text = replace(text, "AGGREGATE_PARENTS", "declaration");
        text = replace(text, "CLASS_BODY", "declaration");
        text = replace(text, "CLASS_DECLARATION", "declaration");
        text = replace(text, "CLASS_ELEMENT", "declaration");
        text = replace(text, "CLASS_PARAMETER", "declaration");
        text = replace(text, "CLASS_UNIT", "declaration");
        text = replace(text, "FLOAT_LIST", "declaration");
        text = replace(text, "FORMULA_LIST", "declaration");
        text = replace(text, "IDENTIFIER_LIST", "declaration");
        text = replace(text, "IMPORT_BODY", "declaration");
        text = replace(text, "IMPORT_DECLARATION", "declaration");
        text = replace(text, "IMPORT_UNIT", "declaration");
        text = replace(text, "INTERFACE_BODY", "declaration");
        text = replace(text, "INTERFACE_DECLARATION", "declaration");
        text = replace(text, "INTERFACE_UNIT", "declaration");
        text = replace(text, "LABEL_LIST", "declaration");
        text = replace(text, "PARAMETER_LIST", "declaration");
        text = replace(text, "PREFIXED_LABEL", "declaration");
        text = replace(text, "RAW_CPT", "declaration");
        text = replace(text, "REFERENCE_SLOT", "declaration");
        text = replace(text, "RULE_CPT", "declaration");
        text = replace(text, "SYSTEM_BODY", "declaration");
        text = replace(text, "SYSTEM_DECLARATION", "declaration");
        text = replace(text, "SYSTEM_UNIT", "declaration");
        text = replace(text, "TYPE_DECLARATION", "declaration");
        text = replace(text, "TYPE_LABEL", "declaration");
        text = replace(text, "TYPE_UNIT", "declaration");
        text = replace(text, "TYPE_VALUE_LIST", "declaration");

        text = replace(text, "AGGREGATE", "declaration");
        text = replace(text, "ARRAY", "declaration");
        text = replace(text, "ATTRIBUTE", "declaration");
        text = replace(text, "CAST", "declaration");
        text = replace(text, "CHAIN", "declaration");
        text = replace(text, "CLASS", "declaration");
        text = replace(text, "FLOAT", "declaration");
        text = replace(text, "FORMULA", "declaration");
        text = replace(text, "IDENTIFIER", "declaration");
        text = replace(text, "INT", "declaration");
        text = replace(text, "INTEGER", "declaration");
        text = replace(text, "INTERFACE", "declaration");
        text = replace(text, "LABEL", "declaration");
        text = replace(text, "LINK", "declaration");
        text = replace(text, "MAP", "declaration");
        text = replace(text, "PARAMETER", "declaration");
        text = replace(text, "REAL", "declaration");
        text = replace(text, "RULE", "declaration");
        text = replace(text, "TYPE", "declaration");
        text = replace(text, "UNIT", "declaration");

        return text;
      }

copyImports__()

template<typename GUM_SCALAR >

INLINE std::vector< const O3Import *> gum::prm::o3prm::O3prmReader< GUM_SCALAR >::copyImports__ ( )

private

Definition at line 412 of file O3prmReader_tpl.h.

                                                      {
        auto copy = std::vector< const O3Import* >();
        for (const auto& i: o3_prm__->imports()) {
          if (!imported__.exists(i->import().label())) { copy.push_back(i.get()); }
        }
        return copy;
      }

errCol()

template<typename GUM_SCALAR >

INLINE Idx gum::prm::o3prm::O3prmReader< GUM_SCALAR >::errCol

(

Idx

i

)

const

col of ith error or warning

Definition at line 240 of file O3prmReader_tpl.h.

                                                              {
        return errors__.error(i).column;
      }

errFilename()

template<typename GUM_SCALAR >

INLINE std::wstring gum::prm::o3prm::O3prmReader< GUM_SCALAR >::errFilename

(

Idx

i

)

const

filename of ith error or warning

Definition at line 245 of file O3prmReader_tpl.h.

                                                                          {
        return widen(errors__.error(i).filename);
      }

errIsError()

template<typename GUM_SCALAR >

INLINE bool gum::prm::o3prm::O3prmReader< GUM_SCALAR >::errIsError

(

Idx

i

)

const

type of ith error or warning

Definition at line 250 of file O3prmReader_tpl.h.

                                                                   {
        return errors__.error(i).is_error;
      }

errLine()

template<typename GUM_SCALAR >

INLINE Idx gum::prm::o3prm::O3prmReader< GUM_SCALAR >::errLine

(

Idx

i

)

const

line of ith error or warning

Definition at line 235 of file O3prmReader_tpl.h.

                                                               {
        return errors__.error(i).line;
      }

errMsg()

template<typename GUM_SCALAR >

INLINE std::string gum::prm::o3prm::O3prmReader< GUM_SCALAR >::errMsg

(

Idx

i

)

const

message of ith error or warning

Definition at line 255 of file O3prmReader_tpl.h.

                                                                    {
        return errors__.error(i).msg;
      }

errors()

template<typename GUM_SCALAR >

INLINE Size gum::prm::o3prm::O3prmReader< GUM_SCALAR >::errors

(

)

const

publishing Errors API

of errors

Definition at line 284 of file O3prmReader_tpl.h.

                                                          {
        return errors__.error_count;
      }

errorsContainer()

template<typename GUM_SCALAR >

INLINE const ErrorsContainer & gum::prm::o3prm::O3prmReader< GUM_SCALAR >::errorsContainer

(

)

const

publishing Errors API

of errors

Definition at line 295 of file O3prmReader_tpl.h.

                                                                    {
        return errors__;
      }

operator=() [1/2]

template<typename GUM_SCALAR >

INLINE O3prmReader< GUM_SCALAR > & gum::prm::o3prm::O3prmReader< GUM_SCALAR >::operator=

(

const O3prmReader< GUM_SCALAR > &

src

)

Definition at line 177 of file O3prmReader_tpl.h.

                                                                    {
        if (this == &src) { return *this; }
        prm__        = src.prm__;
        o3_prm__     = std::unique_ptr< O3PRM >(new O3PRM(*(src.o3_prm__)));
        class_path__ = src.class_path__;
        imported__   = src.imported__;
        errors__     = src.errors__;
        return *this;
      }

operator=() [2/2]

template<typename GUM_SCALAR >

INLINE O3prmReader< GUM_SCALAR > & gum::prm::o3prm::O3prmReader< GUM_SCALAR >::operator=

(

O3prmReader< GUM_SCALAR > &&

src

)

Definition at line 189 of file O3prmReader_tpl.h.

                                                               {
        if (this == &src) { return *this; }
        prm__        = std::move(src.prm__);
        o3_prm__     = std::move(src.o3_prm__);
        class_path__ = std::move(src.class_path__);
        imported__   = std::move(src.imported__);
        errors__     = std::move(src.errors__);
        return *this;
      }

parseImport__()

template<typename GUM_SCALAR >

INLINE void gum::prm::o3prm::O3prmReader< GUM_SCALAR >::parseImport__ ( const O3Import &  i, const std::string &  module_path  )

private

Definition at line 369 of file O3prmReader_tpl.h.

                                                                           {
        if (!imported__.exists(i.import().label())) {
          imported__.insert(i.import().label());

          auto module_path = module;
          std::replace(module_path.begin(), module_path.end(), '.', '/');

          auto path = i.import().label();
          std::replace(path.begin(), path.end(), '.', '/');

          auto imported = false;
          for (const auto& cp: class_path__) {
            auto          file_path = cp + path + ".o3prm";
            std::ifstream file(file_path);

            if (file.is_open()) {
              parseStream__(file, file_path, i.import().label());
              imported = true;
              break;
            }

            file_path = cp + module + path + ".o3prm";
            std::ifstream file2(file_path);

            if (file2.is_open()) {
              parseStream__(file2, file_path, module + "." + i.import().label());
              imported = true;
              break;
            }
          }

          if (!imported) {
            const auto&       pos = i.import().position();
            std::stringstream msg;
            msg << "Import error: could not resolve import " << i.import().label();
            errors__.addError(msg.str(), pos.file(), pos.line(), pos.column());
          }
        }
      }

parseStream()

template<typename GUM_SCALAR >

INLINE void gum::prm::o3prm::O3prmReader< GUM_SCALAR >::parseStream	(	std::istream &	input,
		std::ostream &	output,
		std::string	module = ""
	)

Definition at line 342 of file O3prmReader_tpl.h.

                                                                             {
        readStream__(input, "", module);

        showElegantErrorsAndWarnings(output);
      }

parseStream__()

template<typename GUM_SCALAR >

INLINE void gum::prm::o3prm::O3prmReader< GUM_SCALAR >::parseStream__ ( std::istream &  input, const std::string &  filename, const std::string &  module  )

private

Definition at line 352 of file O3prmReader_tpl.h.

                                                                           {
        auto sBuff  = readStream__(input);
        auto buffer = std::unique_ptr< unsigned char[] >(
           new unsigned char[sBuff.length() + 1]);
        strcpy((char*)buffer.get(), sBuff.c_str());
        auto s = o3prm_scanner(buffer.get(), int(sBuff.length() + 1), filename);
        auto p = o3prm_parser(&s);
        p.set_prm(o3_prm__.get());
        p.set_prefix(module);
        p.Parse();
        errors__ += p.errors();
      }

print__()

template<typename GUM_SCALAR >

INLINE std::string gum::prm::o3prm::O3prmReader< GUM_SCALAR >::print__ ( const ParseError &  err ) const

private

Definition at line 110 of file O3prmReader_tpl.h.

                                                                           {
        std::stringstream s;
        s << err.filename << "|" << err.line << " col " << err.column << "| "
          << clean__(err.msg);
        return s.str();
      }

prm() [1/2]

template<typename GUM_SCALAR>

gum::prm::PRM< GUM_SCALAR >* gum::prm::o3prm::O3prmReader< GUM_SCALAR >::prm ( )

inline

Definition at line 109 of file O3prmReader.h.

{ return prm__; }

prm() [2/2]

template<typename GUM_SCALAR>

const gum::prm::PRM< GUM_SCALAR >* gum::prm::o3prm::O3prmReader< GUM_SCALAR >::prm ( ) const

inline

Definition at line 110 of file O3prmReader.h.

{ return prm__; }

readFile()

template<typename GUM_SCALAR >

INLINE Size gum::prm::o3prm::O3prmReader< GUM_SCALAR >::readFile	(	const std::string &	file,
		const std::string &	module = ""
	)

Read file and load its content using a PRMFactory. The package parameter set the file's content package.

Definition at line 307 of file O3prmReader_tpl.h.

                                                                               {
        try {
          auto lastSlashIndex = file.find_last_of('/');

          auto dir = Directory(file.substr(0, lastSlashIndex + 1));

          if (!dir.isValid()) {
            errors__.addException("could not find file", file);
            return errors__.count();
          }

          auto basename    = file.substr(lastSlashIndex + 1);
          auto absFilename = dir.absolutePath() + basename;

          std::ifstream input(absFilename);
          if (input.is_open()) {
            readStream__(input, file, module);
          } else {
            errors__.addException("could not open file", file);
          }

          return errors__.count();

        } catch (gum::Exception& e) {
          GUM_SHOWERROR(e);
          errors__.addException(e.errorContent(), file);
          return errors__.count();
        } catch (...) {
          errors__.addException("unknown error", file);
          return errors__.count();
        }
      }

readStream__() [1/2]

template<typename GUM_SCALAR >

INLINE void gum::prm::o3prm::O3prmReader< GUM_SCALAR >::readStream__ ( std::istream &  input, const std::string &  file, std::string  module = ""  )

private

Definition at line 421 of file O3prmReader_tpl.h.

                                                                            {
        if (module.size() > 0 && module.back() != '.') { module.append("."); }

        parseStream__(input, file, module);

        auto imports = copyImports__();
        do {
          for (auto i: imports) {
            parseImport__(*i, module);
          }
          imports = copyImports__();
        } while (imports.size() > 0);


        if (errors__.error_count == 0) {
          auto solver = O3NameSolver< GUM_SCALAR >(*prm__, *o3_prm__, errors__);
          auto type_factory
             = O3TypeFactory< GUM_SCALAR >(*prm__, *o3_prm__, solver, errors__);

          auto interface_factory = O3InterfaceFactory< GUM_SCALAR >(*prm__,
                                                                    *o3_prm__,
                                                                    solver,
                                                                    errors__);
          auto class_factory
             = O3ClassFactory< GUM_SCALAR >(*prm__, *o3_prm__, solver, errors__);

          auto system_factory
             = O3SystemFactory< GUM_SCALAR >(*prm__, *o3_prm__, solver, errors__);

          try {
            type_factory.build();
            interface_factory.buildInterfaces();
            class_factory.buildClasses();
            interface_factory.buildElements();
            class_factory.buildImplementations();
            class_factory.buildParameters();
            class_factory.buildReferenceSlots();
            class_factory.declareAttributes();
            class_factory.declareAggregates();
            class_factory.completeAggregates();
            class_factory.completeAttributes();
            system_factory.build();
          } catch (Exception&) {
            if (errors__.count() == 0) {
              errors__.addException("an unknown error occured", file);
            }
            // GUM_TRACE_NEWLINE;
            // GUM_SHOWERROR( e );
          } catch (...) {
            errors__.addException("an unknown exception occured", file);
          }
        }
      }

readStream__() [2/2]

template<typename GUM_SCALAR >

INLINE std::string gum::prm::o3prm::O3prmReader< GUM_SCALAR >::readStream__ ( std::istream &  input )

private

Definition at line 119 of file O3prmReader_tpl.h.

                                                                         {
        if (inputstr) {
          inputstr.seekg(0, inputstr.end);
          int length = int(inputstr.tellg());
          inputstr.seekg(0, inputstr.beg);

          auto str = std::string();
          str.resize(length, ' ');
          auto begin = &*str.begin();

          inputstr.read(begin, length);

          return str;
        }
        GUM_ERROR(OperationNotAllowed, "Could not open file");
      }

readString()

template<typename GUM_SCALAR >

INLINE Size gum::prm::o3prm::O3prmReader< GUM_SCALAR >::readString

(

const std::string &

string

)

With readString method, you must set the current path to search from import yourself, using addClassPath.

Definition at line 300 of file O3prmReader_tpl.h.

                                                                            {
        std::stringstream sBuff(str);
        readStream__(sBuff, "");
        return errors__.count();
      }

setClassPath()

template<typename GUM_SCALAR >

void gum::prm::o3prm::O3prmReader< GUM_SCALAR >::setClassPath

(

const std::string &

class_path

)

This methods defines the list of paths to look for o3prm files.

Use / for path separator ! Even on Windows !

Parameters

class_path

A semicolon separated list of paths.

Definition at line 200 of file O3prmReader_tpl.h.

                                                                              {
        class_path__ = std::vector< std::string >();
        size_t i     = 0;
        size_t j     = class_path.find(';');

        while (j != std::string::npos) {
          addClassPath(class_path.substr(i, j - i));
          i = j + 1;

          if (i < class_path.size()) {
            j = class_path.find(';', i);
          } else {
            j = std::string::npos;
          }
        }

        if (i < class_path.size()) {
          addClassPath(class_path.substr(i, std::string::npos));
        }
      }

showElegantErrors()

template<typename GUM_SCALAR >

INLINE void gum::prm::o3prm::O3prmReader< GUM_SCALAR >::showElegantErrors

(

std::ostream &

o = std::cerr

)

const

send on std::cerr the list of errors

Definition at line 261 of file O3prmReader_tpl.h.

                                                                         {
        for (Idx i = 0; i < errors__.count(); ++i) {
          auto err = errors__.error(i);
          if (err.is_error) { o << print__(err) << std::endl; }
        }
      }

showElegantErrorsAndWarnings()

template<typename GUM_SCALAR >

INLINE void gum::prm::o3prm::O3prmReader< GUM_SCALAR >::showElegantErrorsAndWarnings

(

std::ostream &

o = std::cerr

)

const

send on std::cerr the list of errors or warnings

Definition at line 269 of file O3prmReader_tpl.h.

                              {
        for (Idx i = 0; i < errors__.count(); ++i) {
          auto err = errors__.error(i);
          o << print__(err) << std::endl;
        }
      }

showErrorCounts()

template<typename GUM_SCALAR >

INLINE void gum::prm::o3prm::O3prmReader< GUM_SCALAR >::showErrorCounts

(

std::ostream &

o = std::cerr

)

const

send on std::cerr the number of errors and the number of warnings

Definition at line 279 of file O3prmReader_tpl.h.

                                                                       {
        errors__.syntheticResults(o);
      }

warnings()

template<typename GUM_SCALAR >

INLINE Size gum::prm::o3prm::O3prmReader< GUM_SCALAR >::warnings

(

)

const

of errors

Definition at line 289 of file O3prmReader_tpl.h.

                                                            {
        return errors__.warning_count;
      }

Member Data Documentation

class_path__

template<typename GUM_SCALAR>

std::vector< std::string > gum::prm::o3prm::O3prmReader< GUM_SCALAR >::class_path__

private

Definition at line 147 of file O3prmReader.h.

errors__

template<typename GUM_SCALAR>

ErrorsContainer gum::prm::o3prm::O3prmReader< GUM_SCALAR >::errors__

private

Definition at line 151 of file O3prmReader.h.

imported__

template<typename GUM_SCALAR>

Set< std::string > gum::prm::o3prm::O3prmReader< GUM_SCALAR >::imported__

private

Definition at line 148 of file O3prmReader.h.

o3_prm__

template<typename GUM_SCALAR>

std::unique_ptr< O3PRM > gum::prm::o3prm::O3prmReader< GUM_SCALAR >::o3_prm__

private

Definition at line 146 of file O3prmReader.h.

prm__

template<typename GUM_SCALAR>

PRM< GUM_SCALAR >* gum::prm::o3prm::O3prmReader< GUM_SCALAR >::prm__

private

Definition at line 145 of file O3prmReader.h.

---

The documentation for this class was generated from the following files:

• agrum/PRM/o3prm/O3prmReader.h
• agrum/PRM/o3prm/O3prmReader_tpl.h