Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

             

---

XalanXMLFileReporter.hpp

Go to the documentation of this file.

/*
 * Copyright 1999-2004 The Apache Software Foundation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#if !defined(HARNESS_HEADER_GUARD_1357924680)
#define HARNESS_HEADER_GUARD_1357924680



#include "xalanc/Harness/XalanHarnessDefinitions.hpp"



#include <cstdio>



#include "xalanc/XalanDOM/XalanDOMString.hpp"



#include "xalanc/Include/XalanMemMgrHelper.hpp"
#include "xalanc/Include/XalanMap.hpp"



#include "xalanc/PlatformSupport/DOMStringHelper.hpp"



XALAN_CPP_NAMESPACE_BEGIN




class XALAN_HARNESS_EXPORT XalanXMLFileReporter
{
    
public:

    typedef XalanMap<XalanDOMString, XalanDOMString>  Hashtable;

#if defined(XALAN_STRICT_ANSI_HEADERS)
    typedef std::FILE   FileHandleType;
#else
    typedef FILE        FileHandleType;
#endif

public:


    // Construct and initialize this reporter with specified filename, if
    // the filename is not empty.
    XalanXMLFileReporter(MemoryManagerType& theManager, const XalanDOMString& fileName);

    // Initialize this XalanXMLFileReporter.  Must be called before attempting to log anything.
    bool initialize(MemoryManagerType& theManager);

    MemoryManagerType&
    getMemoryManager()
    {
        return m_fileName.getMemoryManager();
    }

    // Accessor for flushing; is set from properties.
    bool getFlushOnCaseClose();

    // Accessor methods for our properties block.
    const XalanDOMString& getFileName() const;

    // Accessor methods for our properties block.
    void setFileName(const XalanDOMString& fileName);

    // Accessor methods for our properties block.
    void setFileName(const char* fileName, MemoryManagerType& theManager)
    {
        setFileName(XalanDOMString(fileName, theManager));
    }

    //
    // Is this Reporter still running OK?  
    // @returns status - true if an error has occoured, false if it's still working fine
    bool checkError();

      
    //
    // Is this Reporter ready to log results?  
    // @returns status - true if it's ready to report, false otherwise
    bool isReady();

    // Flush this reporter - ensure our File is flushed.
    void flush();


    // Close this reporter - ensure our File, etc. are closed.
    void close();

    //-----------------------------------------------------
    //-------- Testfile / Testcase start and stop routines --------
    //-----------------------------------------------------

    void logTestFileInit(const XalanDOMString& msg);

    void logTestFileInit(const char*    msg)
    {
        logTestFileInit(XalanDOMString(msg,  getMemoryManager()));
    }

    void logTestFileClose(const XalanDOMString& msg, const XalanDOMString& result);

    void logTestFileClose(const char* msg, const char* result)
    {
        logTestFileClose(XalanDOMString(msg, getMemoryManager()), XalanDOMString(result, getMemoryManager()));  
    }

    void logTestCaseInit(const XalanDOMString& msg);

    void logTestCaseInit(const char*    msg)
    {
        logTestCaseInit(XalanDOMString(msg,  getMemoryManager()));
    }

    void logTestCaseClose(const XalanDOMString& msg, const XalanDOMString& result);

    void logTestCaseClose(const char* msg, const char* result)
    {
        logTestCaseClose(XalanDOMString(msg , getMemoryManager()), XalanDOMString(result , getMemoryManager()));
    }
    //-----------------------------------------------------
    //-------- Test results reporting and logging routines --------
    //-----------------------------------------------------


    void logMessage(int level, const XalanDOMString& msg);

    void logStatistic (int level, long lVal, double dVal, const XalanDOMString& msg);

    void logStatistic (int level, long lVal, double dVal, const char*   msg)
    {
        logStatistic(level, lVal, dVal, XalanDOMString(msg, getMemoryManager()));
    }

    // This routine will add an attribute to the attribute list.
    void addMetricToAttrs(char* desc, double theMetric, Hashtable& attrs);

    void logElementWAttrs(int level, const XalanDOMString& element, Hashtable& attrs, const XalanDOMString& msg);

    void logElementWAttrs(int level,  const char* element, Hashtable& attrs, const char* msg)
    {
        logElementWAttrs(level, XalanDOMString(element, getMemoryManager()), attrs, XalanDOMString(msg, getMemoryManager()));
    }

    void logElement(int level, const XalanDOMString& element, const XalanDOMString& msg);

    void logElement(const XalanDOMString& element, const XalanDOMString& msg);
    void logArbitraryMessage (int level, const XalanDOMString& msg);

    /*
    void logHashtable (int level, Hashtable hash, const XalanDOMString& msg);
    */

    void logCheckPass(const XalanDOMString& comment);

    void logCheckAmbiguous(const XalanDOMString& comment);

    void logCheckFail(const XalanDOMString& comment);

    void logCheckFail(const XalanDOMString& test, const Hashtable& faildata, const Hashtable& actexp);

    void logCheckFail(const XalanDOMString& test, const Hashtable& actexp);

    void logErrorResult(const XalanDOMString& test, const XalanDOMString& reason);

    void logCheckErr(const XalanDOMString& comment);

    XalanDOMString& escapestring(const XalanDOMString& s, XalanDOMString&      buffer);


private:
    // not implemented
    XalanXMLFileReporter(const XalanXMLFileReporter&);
    bool startResultsFile();

    bool closeResultsFile();

    bool printToFile(const XalanDOMString& output);

    void
    initStrings();

    XalanDOMString&
    getDateTimeString(XalanDOMString& result);
    
    XalanDOMString  OPT_FILENAME;

    XalanDOMString  ELEM_RESULTSFILE;
    XalanDOMString  ELEM_TESTFILE;
    XalanDOMString  ELEM_FILERESULT;
    XalanDOMString  ELEM_TESTCASE;
    XalanDOMString  ELEM_CASERESULT;
    XalanDOMString  ELEM_CHECKRESULT;
    XalanDOMString  ELEM_STATISTIC;
    XalanDOMString  ELEM_LONGVAL;
    XalanDOMString  ELEM_DOUBLEVAL;
    XalanDOMString  ELEM_MESSAGE;
    XalanDOMString  ELEM_ARBITRARY;
    XalanDOMString  ELEM_HASHTABLE;
    XalanDOMString  ELEM_HASHITEM;

    XalanDOMString  ATTR_LEVEL;
    XalanDOMString  ATTR_DESC;
    XalanDOMString  ATTR_TIME;
    XalanDOMString  ATTR_RESULT;
    XalanDOMString  ATTR_KEY;
    XalanDOMString  ATTR_FILENAME;
    XalanDOMString  LESS_THAN;
    XalanDOMString  GREATER_THAN;
    XalanDOMString  EQUALS_QUOTE;
    XalanDOMString  SPACE;
    XalanDOMString  QUOTE;
    XalanDOMString  QUOTE_SPACE;
    XalanDOMString  QUOTE_GREATER_THAN;
    XalanDOMString  QUOTE_SOLIDUS_GREATER_THAN;
    XalanDOMString  PASS;
    XalanDOMString  AMBG;
    XalanDOMString  ERRR;
    XalanDOMString  FAIL;
    XalanDOMString  LESS_THAN_SOLIDUS;
    XalanDOMString  XML_HEADER;
    XalanDOMString  REASON_EQUALS_QUOTE;

    XalanDOMString  TESTCASEINIT_HDR;
    XalanDOMString  TESTCASECLOSE_HDR;
    XalanDOMString  MESSAGE_HDR;
    XalanDOMString  STATISTIC_HDR;
    XalanDOMString  ARBITRARY_HDR;
    XalanDOMString  HASHTABLE_HDR;
    XalanDOMString  HASHITEM_HDR;
    XalanDOMString  CHECKPASS_HDR;
    XalanDOMString  CHECKAMBG_HDR;
    XalanDOMString  CHECKERRR_HDR;
    XalanDOMString  CHECKFAIL_HDR;
    XalanDOMString  CHECKFAIL_FTR;

    bool m_anyOutput;

    XalanDOMString m_fileName;

    FileHandleType* m_fileHandle;

    bool m_ready;

    bool m_error;

    bool m_flushOnCaseClose;

};        // end of class XalanXMLFileReporter



XALAN_CPP_NAMESPACE_END



#endif

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.10 Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.