/************************************************************************* * * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: xmlerror.hxx,v $ * * $Revision: 1.12 $ * * last change: $Author: rt $ $Date: 2005-09-09 13:14:02 $ * * The Contents of this file are made available subject to * the terms of GNU Lesser General Public License Version 2.1. * * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2005 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library 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 * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * ************************************************************************/ #ifndef _XMLOFF_XMLERROR_HXX #define _XMLOFF_XMLERROR_HXX #ifndef _COM_SUN_STAR_XML_SAX_SAXPARSEEXCEPTION_HPP_ #include #endif #ifndef _SAL_TYPES_H_ #include #endif // STL includes #include // masks for the error ID fields #define XMLERROR_MASK_FLAG 0xF0000000 #define XMLERROR_MASK_CLASS 0x00FF0000 #define XMLERROR_MASK_NUMBER 0x0000FFFF // error flags: #define XMLERROR_FLAG_WARNING 0x10000000 #define XMLERROR_FLAG_ERROR 0x20000000 #define XMLERROR_FLAG_SEVERE 0x40000000 // error classes: Error ID #define XMLERROR_CLASS_IO 0x00010000 #define XMLERROR_CLASS_FORMAT 0x00020000 #define XMLERROR_CLASS_API 0x00040000 #define XMLERROR_CLASS_OTHER 0x00080000 // error numbers, listed by error class // Within each class, errors should be numbered consecutively. Please // allways add to error code below the appropriate comment. // I/O errors: // format errors: #define XMLERROR_SAX ( XMLERROR_CLASS_FORMAT | 0x00000001 ) #define XMLERROR_STYLE_ATTR_VALUE ( XMLERROR_CLASS_FORMAT | 0x00000002 ) #define XMLERROR_NO_INDEX_ALLOWED_HERE ( XMLERROR_CLASS_FORMAT | 0x00000003 ) #define XMLERROR_PARENT_STYLE_NOT_ALLOWED ( XMLERROR_CLASS_FORMAT | 0x00000004 ) #define XMLERROR_ILLEGAL_EVENT (XMLERROR_CLASS_FORMAT | 0x00000005 ) #define XMLERROR_NAMESPACE_TROUBLE (XMLERROR_CLASS_FORMAT | 0x00000006 ) #define XMLERROR_XFORMS_NO_SCHEMA_SUPPORT ( XMLERROR_CLASS_FORMAT | XMLERROR_FLAG_WARNING | 0x00000007 ) #define XMLERROR_XFORMS_UNKNOWN ( XMLERROR_CLASS_FORMAT | XMLERROR_FLAG_WARNING | 0x00000008 ) #define XMLERROR_XFORMS_ONLY_ONE_INSTANCE_ELEMENT ( XMLERROR_CLASS_FORMAT | XMLERROR_FLAG_WARNING | 0x00000009 ) #define XMLERROR_UNKNOWN_ATTRIBUTE ( XMLERROR_CLASS_FORMAT | XMLERROR_FLAG_WARNING | 0x0000000a ) #define XMLERROR_UNKNOWN_ELEMENT ( XMLERROR_CLASS_FORMAT | XMLERROR_FLAG_WARNING | 0x0000000b ) #define XMLERROR_UNKNOWN_CHARACTERS ( XMLERROR_CLASS_FORMAT | XMLERROR_FLAG_WARNING | 0x0000000c ) #define XMLERROR_UNKNWON_ROOT (XMLERROR_CLASS_FORMAT | 0x0000000d ) // API errors: #define XMLERROR_STYLE_PROP_VALUE ( XMLERROR_CLASS_API | 0x00000001 ) #define XMLERROR_STYLE_PROP_UNKNOWN ( XMLERROR_CLASS_API | 0x00000002 ) #define XMLERROR_STYLE_PROP_OTHER ( XMLERROR_CLASS_API | 0x00000003 ) #define XMLERROR_API ( XMLERROR_CLASS_API | 0x00000004 ) // other errors: #define XMLERROR_CANCEL ( XMLERROR_CLASS_OTHER | 0x00000001 ) // 16bit error flag constants for use in the // SvXMLExport/SvXMLImport error flags #define ERROR_NO 0x0000 #define ERROR_DO_NOTHING 0x0001 #define ERROR_ERROR_OCCURED 0x0002 #define ERROR_WARNING_OCCURED 0x0004 // forward declarations namespace rtl { class OUString; } namespace com { namespace sun { namespace star { namespace uno { template class Sequence; } namespace uno { template class Reference; } namespace xml { namespace sax { class XLocator; } } } } } class ErrorRecord; /** * The XMLErrors is used to collect all errors and warnings that occur * for appropriate processing. */ class XMLErrors { /// definition of type for error list typedef ::std::vector ErrorList; ErrorList aErrors; /// list of error records public: XMLErrors(); ~XMLErrors(); /// add a new entry to the list of error messages void AddRecord( sal_Int32 nId, /// error ID == error flags + error class + error number const ::com::sun::star::uno::Sequence< ::rtl::OUString> & rParams, /// parameters for error message const ::rtl::OUString& rExceptionMessage, /// original exception string sal_Int32 nRow, /// XLocator: file row number sal_Int32 nColumn, /// XLocator: file column number const ::rtl::OUString& rPublicId, /// XLocator: file public ID const ::rtl::OUString& rSystemId ); /// XLocator: file system ID void AddRecord( sal_Int32 nId, /// error ID == error flags + error class + error number const ::com::sun::star::uno::Sequence< ::rtl::OUString> & rParams, /// parameters for error message const ::rtl::OUString& rExceptionMessage, /// original exception string const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XLocator> & rLocator); /// location void AddRecord( sal_Int32 nId, /// error ID == error flags + error class + error number const ::com::sun::star::uno::Sequence< ::rtl::OUString> & rParams, /// parameters for error message const ::rtl::OUString& rExceptionMessage); /// original exception string void AddRecord( sal_Int32 nId, /// error ID == error flags + error class + error number const ::com::sun::star::uno::Sequence< ::rtl::OUString> & rParams); /// parameters for error message /** * throw a SAXParseException that describes the first error that matches * the given mask */ void ThrowErrorAsSAXException( sal_Int32 nIdMask ) throw( ::com::sun::star::xml::sax::SAXParseException ); }; #endif