SXmlReader.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshPluginScript/SClass/SObject.h"
#include <QtCore/SFile>
#include <QtCore/SXmlReader>
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SXmlReader : public SObject
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public:
    enum ErrorEnum
    {
        NoError, // No error has occurred.
        NotWellFormedError, // The parser internally raised an error due to the read XML not being well-formed.
        PrematureEndOfDocumentError, // The input stream ended before a well-formed XML document was parsed.
        UnexpectedElementError// The parser encountered an element that was different to those it expected.
    };
 
    enum TokenTypeEnum
    {
        NoToken, // The reader has not yet read anything.
        Invalid, // An error has occurred, reported in error().
        StartDocument, // The reader reports the XML version number in DocumentVersion(),
        // and the encoding as specified in the XML document in DocumentEncoding(). If the document is declared standalone,
        // IsStandaloneDocument() returns true; otherwise it returns false.
        EndDocument, // The reader reports the end of the document.
        StartElement, // The reader reports the start of an element with NamespaceUri() and Name().
        // Empty elements are also reported as StartElement, followed directly by EndElement. Attributes are
        // reported in Attributes().
        EndElement, // The reader reports the end of an element with NamespaceUri() and Name().
        Characters, // The reader reports characters in Text(). If the characters are all white-space,
        // IsWhitespace() returns true.
        Comment, // The reader reports a comment in Text().
        DTD,
        EntityReference,
        ProcessingInstruction};
 
public slots: // these functions (slots) will be available in QtScript
     SetFile(SFile File);
    Boolean AtEnd() ;
    Array Attributes() ;
    String DocumentEncoding() ;
    String DocumentVersion() ;
    Boolean HasError() ;
    ErrorEnum Error() ;
    Boolean IsStandaloneDocument() ;
    Boolean IsWhitespace() ;
    Number LineNumber() ;
    String Name() ;
    String NamespaceUri() ;
    TokenTypeEnum ReadNext();
     SkipCurrentElement();
    String Text() ;
    String TokenString() ;
    TokenTypeEnum TokenType() ;
 
    String toString() ;
};
 
// @brief
// This class allows to wrap static functions to SXmlReader easily.
// This allow to wrap constructor more easily : the constructor will be declared with the function New(...)
class SXmlReader
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public slots:
    // TESTED
    static SXmlReader New();
 
    static String toString();
};
Q_DECLARE_METATYPE(SXmlReader::_SXmlReaderDummy);
Q_DECLARE_METATYPE(SXmlReader);
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC
 
Q_DECLARE_METATYPE(SXmlReader);
Q_DECLARE_METATYPE(SXmlReader);