arcsxmlhandler.h

/*
  name: include/arcs/arcsxmlhandler.h

  This file is part of ARCS - Augmented Reality Component System
  (version 2-current), written by Jean-Yves Didier 
  for IBISC Laboratory (http://www.ibisc.univ-evry.fr)

  Copyright (C) 2013  Université d'Evry-Val d'Essonne

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 2 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.


  Please send bugreports  with examples or suggestions to
  jean-yves.didier__at__ibisc.univ-evry.fr
*/


#ifndef __ARCSXMLHANDLER_H__
#define __ARCSXMLHANDLER_H__

#include <QDomDocument>

#include <arcs/arcssheet.h>

#include <QFileInfo>
#include <QList>

class ARCSSheet;
class ARCSContext;
class ARCSAbstractComponent;
class ARCSCompositeComponent;
class ARCSApplicationComponent;
class ARCSStateMachine;
class ARCSFactory;
class ARCSProcess;



class DLL_EXPORT ARCSXMLHandler
{
public:
     ARCSXMLHandler();
     ~ARCSXMLHandler();
     
     enum XMLType 
     { XML_BLANK, 
       XML_STATEMACHINE, 

       XML_COMPOSITE,  
       XML_APPLICATION,  
       XML_INTERFACE, 
       XML_PROFILE 
     };




     bool openFile(QString s);

     bool saveFile(QString s);


     bool setContents(QString s); 
     QString getContents(); 


     void setType(XMLType t) { type = t; }
     XMLType getType(); // { return type; }



     bool parseProcess(ARCSProcess* ap, QDomElement processNode);


     bool parseSheet(ARCSSheet* as, QDomElement father); // pr ?

     bool parseContext(ARCSContext*); // pr ?
     QStringList parseLibraries(QDomElement libraries,bool* ok=0);  // pr ?

     bool parseInterface(ARCSAbstractComponent* aac,
                         QDomNode node = QDomNode());


     bool parseStateMachine(ARCSStateMachine*);
     bool parseApplication(ARCSApplicationComponent*);
     bool parseCompositeComponent(ARCSCompositeComponent*);

     bool parseProfile(ARCSContext*);


     void storeSheet(ARCSSheet* as, QDomElement father,
                     QString id=QString::null);
     void storeContext(ARCSContext*); // pr ?
     void storeStateMachine(ARCSStateMachine*);

     void storeProfile(ARCSContext*);

     void storeProcess(ARCSProcess*,QDomElement father); //{}
     void storeApplication(ARCSApplicationComponent*);
     void storeCompositeComponent(ARCSCompositeComponent*);

     void storeInterface(ARCSAbstractComponent* aac,
                         QDomElement father= QDomElement());

private:
     bool storeInvocations(ARCSSheet* sheet, ARCSSheet::GetInvocationsMethod,
                           QDomElement root);
     void storeSheetProperties(ARCSSheet* sheet,QDomElement root);

     void parseContextElement(QDomElement elt, ARCSContext* ctx,
                                     QString tagName,
                                     ARCSContext::AddPoolMethod);


     void parseSheetProperties(QDomElement elt,ARCSSheet* sheet);
     void parseInvocation(QDomElement elt, ARCSSheet* sheet,
                          ARCSSheet::AddInvocationMethod method);

     void parseMethodList(QDomElement elt,QStringList & aliases,
                                 QStringList & components,
                                 QStringList & methods);

     static QString nodeInternalsToText(QDomNode node);
     bool parseComponents(QDomElement elt, ARCSContext* ctx);

     void parseConstants(QDomElement elt, ARCSContext* ctx) {
          parseContextElement(elt, ctx, "constant", &ARCSContext::addConstant);
     }

     // will accompany saveFile()
     void computeRelativePaths(QString basePath);
     QString solveRelativePath(QString path);

     void reset();

     //QString contents;
     XMLType type;
     QDomDocument doc;
     ARCSFactory* factory;
     QStringList libraryStrings;

     // The attributes below are used in order to properly store paths.
     QList<QDomAttr> fileAttributes; // attribute store, see saveFile()
     QString fileName; // file in which the document is stored for loadFile()


     QString logSource(int line) {
         return "XML:" + fileName + ":" + QString::number(line);
     }
     QString logSource() {
         return "XML:" + fileName;
     }

};

#endif //__ARCSXMLHANDLER_H__