txtflde.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you 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 .
 */
 
#pragma once
 
#include <com/sun/star/uno/Reference.h>
#include <xmloff/xmlnamespace.hxx>
 
#include <rtl/ustring.hxx>
#include <xmloff/xmltoken.hxx>
 
#include <map>
#include <set>
#include <memory>
#include <string_view>
 
class SvXMLExport;
struct XMLPropertyState;
 
namespace com::sun::star {
    namespace util { struct DateTime; }
    namespace util { struct Date; }
    namespace text { class XTextField; }
    namespace text { class XText; }
    namespace beans { class XPropertySet; }
    namespace beans { class XPropertySetInfo; }
    namespace frame { class XModel; }
    namespace uno { template<typename A> class Sequence; }
}
 
 
//   including translation between UNO speak and XML speak if appropriate
 
enum FieldIdEnum {
    FIELD_ID_SENDER,        // sender == extended user
    FIELD_ID_AUTHOR,
    FIELD_ID_DATE,          // current date
    FIELD_ID_TIME,          // current time (+date)
    FIELD_ID_PAGENAME,      // page/slide name
    FIELD_ID_PAGENUMBER,    // page number
    FIELD_ID_PAGESTRING,    // page continuation string (page number string)
    FIELD_ID_REFPAGE_SET,   // set reference page
    FIELD_ID_REFPAGE_GET,   // get reference page number
 
    FIELD_ID_PLACEHOLDER,   // placeholder field == jump edit field
 
    FIELD_ID_VARIABLE_GET,  // get variable == get expression
    FIELD_ID_VARIABLE_SET,  // set variable == set expression
    FIELD_ID_VARIABLE_INPUT,    // input field (variable)
    FIELD_ID_USER_GET,      // user field
    FIELD_ID_USER_INPUT,    // input field (user field)
    FIELD_ID_TEXT_INPUT,    // input field (text)
    FIELD_ID_EXPRESSION,    // expression field = formula field
    FIELD_ID_SEQUENCE,      // sequence field
 
    FIELD_ID_DATABASE_NEXT,     // select next row
    FIELD_ID_DATABASE_SELECT,   // select row # (NumSet)
    FIELD_ID_DATABASE_DISPLAY,  // display data (form letter field)
    FIELD_ID_DATABASE_NAME,     // display current db name (database name)
    FIELD_ID_DATABASE_NUMBER,   // display row # (SetNumber)
 
    FIELD_ID_DOCINFO_CREATION_AUTHOR,   // docinfo fields
    FIELD_ID_DOCINFO_CREATION_TIME,
    FIELD_ID_DOCINFO_CREATION_DATE,
    FIELD_ID_DOCINFO_DESCRIPTION,
    FIELD_ID_DOCINFO_CUSTOM,
    FIELD_ID_DOCINFO_PRINT_TIME,
    FIELD_ID_DOCINFO_PRINT_DATE,
    FIELD_ID_DOCINFO_PRINT_AUTHOR,
    FIELD_ID_DOCINFO_TITLE,
    FIELD_ID_DOCINFO_SUBJECT,
    FIELD_ID_DOCINFO_KEYWORDS,
    FIELD_ID_DOCINFO_REVISION,
    FIELD_ID_DOCINFO_EDIT_DURATION,
    FIELD_ID_DOCINFO_SAVE_TIME,
    FIELD_ID_DOCINFO_SAVE_DATE,
    FIELD_ID_DOCINFO_SAVE_AUTHOR,
 
    FIELD_ID_CONDITIONAL_TEXT,          // conditionally choose between 2 texts
    FIELD_ID_HIDDEN_TEXT,               // conditionally hide a text
    FIELD_ID_HIDDEN_PARAGRAPH,          // conditionally hide a paragraph
 
    FIELD_ID_TEMPLATE_NAME,     // display name of template
    FIELD_ID_CHAPTER,           // display name/number of current chapter
    FIELD_ID_FILE_NAME,         // display name of current file
 
    FIELD_ID_COUNT_PARAGRAPHS,      // statistics fields: - paragraphs
    FIELD_ID_COUNT_WORDS,           //                    - words
    FIELD_ID_COUNT_CHARACTERS,      //                    - chars
    FIELD_ID_COUNT_PAGES,           //                    - pages
    FIELD_ID_COUNT_TABLES,          //                    - tables
    FIELD_ID_COUNT_GRAPHICS,        //                    - graphics
    FIELD_ID_COUNT_OBJECTS,         //                    - objects
 
    FIELD_ID_MACRO,                 // macro fields
    FIELD_ID_REF_REFERENCE,         // get reference field (reference)
    FIELD_ID_REF_SEQUENCE,          // get reference field (sequence)
    FIELD_ID_REF_BOOKMARK,          // get reference field (bookmark)
    FIELD_ID_REF_FOOTNOTE,          // get reference field (footnote)
    FIELD_ID_REF_ENDNOTE,           // get reference field (endnote)
    FIELD_ID_DDE,                   // DDE field
 
    FIELD_ID_BIBLIOGRAPHY,          // bibliography index entry
 
    FIELD_ID_SHEET_NAME,            // name of current (spread-)sheet
    FIELD_ID_URL,                   // URL field (only Calc, Draw, Impress)
 
    FIELD_ID_SCRIPT,                // script fields (for HTML pages, mostly)
    FIELD_ID_ANNOTATION,            // annotation (notice) field
 
    FIELD_ID_COMBINED_CHARACTERS,   // combined characters (asian typography)
 
    FIELD_ID_META,                  // text:meta-field (RDF metadata)
 
    FIELD_ID_MEASURE,               // for measure shapes
 
    FIELD_ID_TABLE_FORMULA,         // DEPRECATED: table formulas (Writer 2.0)
    FIELD_ID_DROP_DOWN,             // DEPRECATED: dropdown fields (WW8)
 
    FIELD_ID_DRAW_HEADER,
    FIELD_ID_DRAW_FOOTER,
    FIELD_ID_DRAW_DATE_TIME,
 
    FIELD_ID_UNKNOWN        // invalid or unknown field type!
};
 
 
class XMLTextFieldExport final
{
    SvXMLExport& rExport;
 
    std::unique_ptr< ::std::map<
            css::uno::Reference< css::text::XText >,
            ::std::set< OUString > > >
        pUsedMasters;
 
public:
 
    XMLTextFieldExport( SvXMLExport& rExp,
                        std::unique_ptr<XMLPropertyState> pCombinedCharState );
    ~XMLTextFieldExport();
 
    void ExportField(const css::uno::Reference < css::text::XTextField > & rTextField,
                     bool bProgress, bool & rPrevCharIsSpace);
 
    void ExportFieldAutoStyle(const css::uno::Reference < css::text::XTextField > & rTextField,
                 const bool bProgress, const bool bRecursive );
 
    void ExportFieldDeclarations();
 
    void ExportFieldDeclarations(
        const css::uno::Reference < css::text::XText > & rText);
 
    void SetExportOnlyUsedFieldDeclarations(
        bool bExportOnlyUsed = true);
 
    // determine element or attribute names
    // (public, because they may be useful in related XML export classes)
    static enum ::xmloff::token::XMLTokenEnum MapPlaceholderType(sal_uInt16 nType);
    static enum ::xmloff::token::XMLTokenEnum MapTemplateDisplayFormat(sal_Int16 nType);
    static enum ::xmloff::token::XMLTokenEnum MapChapterDisplayFormat(sal_Int16 nType);
    static enum ::xmloff::token::XMLTokenEnum MapFilenameDisplayFormat(sal_Int16 nType);
    static enum ::xmloff::token::XMLTokenEnum MapDocInfoFieldName(enum FieldIdEnum nToken);
    static enum ::xmloff::token::XMLTokenEnum MapReferenceSource(sal_Int16 nType);
    static enum ::xmloff::token::XMLTokenEnum MapReferenceType(sal_Int16 nType);
    static enum ::xmloff::token::XMLTokenEnum MapCountFieldName(FieldIdEnum nToken);
    static enum ::xmloff::token::XMLTokenEnum MapBibliographyFieldName(std::u16string_view sName);
    static enum ::xmloff::token::XMLTokenEnum MapMeasureKind(sal_Int16 nKind);
    static enum ::xmloff::token::XMLTokenEnum MapPageNumberName(const css::uno::Reference< css::beans::XPropertySet> & xPropSet,
                      sal_Int32& nOffset);  
    static enum ::xmloff::token::XMLTokenEnum MapAuthorFieldName(const css::uno::Reference< css::beans::XPropertySet > & xPropSet);
    static enum ::xmloff::token::XMLTokenEnum MapSenderFieldName(const css::uno::Reference< css::beans::XPropertySet > & xPropSet);
 
private:
 
    SvXMLExport& GetExport() { return rExport; }
 
    void ExportFieldHelper(
        const css::uno::Reference< css::text::XTextField> & rTextField,
        const css::uno::Reference< css::beans::XPropertySet> & rPropSet,
        const css::uno::Reference< css::beans::XPropertySet> & rRangePropSet,
        enum FieldIdEnum nToken,
        bool bProgress,
        bool & rPrevCharIsSpace);
 
    void ExportElement(enum ::xmloff::token::XMLTokenEnum eElement, 
                       bool bAddSpace = false); 
 
    void ExportElement(enum ::xmloff::token::XMLTokenEnum eElement, 
                       const OUString& sContent); 
 
    void ExportMacro( const css::uno::Reference< css::beans::XPropertySet> & rPropSet,
                      const OUString& rContent);
 
    void ExportMetaField( const css::uno::Reference< css::beans::XPropertySet> & i_xMeta,
                          bool i_bAutoStyles, bool i_bProgress,
                          bool & rPrevCharIsSpace);
 
    void ProcessBoolean(
        enum ::xmloff::token::XMLTokenEnum eXmlName,    
        bool bBool,     
        bool bDefault); 
 
    void ProcessInteger(
        enum ::xmloff::token::XMLTokenEnum eXmlName,    
        sal_Int32 nNum);            
 
    void ProcessIntegerDef(
        enum ::xmloff::token::XMLTokenEnum eXmlName,    
        sal_Int32 nNum,             
        sal_Int32 nDefault);        
 
    void ProcessString(
        enum ::xmloff::token::XMLTokenEnum eXmlName,        
        const OUString& sValue,  
        bool bOmitEmpty = false, 
        sal_uInt16 nPrefix = XML_NAMESPACE_TEXT);   
 
    void ProcessString(
        enum ::xmloff::token::XMLTokenEnum eXmlName,        
        sal_uInt16 nValuePrefix,
        const OUString& sValue);  
 
 
    void ProcessString(
        enum ::xmloff::token::XMLTokenEnum eXmlName,        
        const OUString& sValue,  
        std::u16string_view sDefault); 
 
    void ProcessString(
        enum ::xmloff::token::XMLTokenEnum eXmlName,        
        sal_uInt16 nValuePrefix,
        const OUString& sValue,  
        std::u16string_view sDefault); 
 
    void ProcessString(
        enum ::xmloff::token::XMLTokenEnum eXmlName,        
        enum ::xmloff::token::XMLTokenEnum eValue,          
        sal_uInt16 nPrefix = XML_NAMESPACE_TEXT);   
 
    void ProcessString(
        enum ::xmloff::token::XMLTokenEnum eXmlName,        
        enum ::xmloff::token::XMLTokenEnum eValue,          
        enum ::xmloff::token::XMLTokenEnum eDefault);       
 
    void ProcessParagraphSequence(
        std::u16string_view sParagraphSequence);
 
    void ProcessNumberingType(
        sal_Int16 nNumberingType);      
 
    void ProcessDisplay(bool bIsVisible,    
                        bool bIsCommand);    
 
    void ProcessValueAndType(
        bool bIsString,     
        sal_Int32 nFormatKey,   
        const OUString& sContent, 
        std::u16string_view sDefault, 
        double fValue,          
        bool bExportValue,  
        bool bExportValueType,  
        bool bExportStyle,  
        bool bForceSystemLanguage, 
        bool bTimeStyle = false); 
 
    void ProcessDateTime(
        enum ::xmloff::token::XMLTokenEnum eXMLName,    
        double dValue,              
        bool bIsDate,           
        bool bIsDuration,           
        bool bOmitDurationIfZero = true,    
        sal_uInt16 nPrefix = XML_NAMESPACE_TEXT);   
 
    void ProcessDateTime(
        enum ::xmloff::token::XMLTokenEnum eXMLName,    
        sal_Int32 nMinutes,             
        bool bIsDate,           
        bool bIsDuration);       
 
    void ProcessDateTime(
        enum ::xmloff::token::XMLTokenEnum eXMLName,    
        const css::util::DateTime& rTime);      
 
    void ProcessTimeOrDateTime(
        enum ::xmloff::token::XMLTokenEnum eXMLName,    
        const css::util::DateTime& rTime);  
 
    void ProcessBibliographyData(
        const css::uno::Reference <
            css::beans::XPropertySet > & rPropertySet);
 
    void ProcessCommandType(
        sal_Int32 nCommandType);        
 
    void ProcessStringSequence(
        const css::uno::Sequence<OUString>& rSequence,
        const OUString& sSelected );
 
    void ProcessStringSequence(
        const css::uno::Sequence<OUString>& rSequence,
        sal_Int32 nSelected );
 
    void ExportDataBaseElement(
        enum ::xmloff::token::XMLTokenEnum eElement,
        const OUString& sContent,
        const css::uno::Reference < css::beans::XPropertySet > & rPropertySet,
        const css::uno::Reference < css::beans::XPropertySetInfo > & rPropertySetInfo );
 
    static css::uno::Reference < css::beans::XPropertySet >
    GetMasterPropertySet(const css::uno::Reference < css::text::XTextField > & rTextField);
 
    static bool GetDependentFieldPropertySet(
        const css::uno::Reference< css::beans::XPropertySet> & xmaster,
        css::uno::Reference< css::beans::XPropertySet> & xField);
 
 
    static enum FieldIdEnum GetFieldID(const css::uno::Reference < css::text::XTextField > & rTextField,
                          const css::uno::Reference < css::beans::XPropertySet > & xPropSet);
 
    static enum FieldIdEnum MapFieldName(std::u16string_view sFieldName,
                            const css::uno::Reference < css::beans::XPropertySet> & xPropSet);
 
    static bool IsStringField(FieldIdEnum nFieldType,  
                           const css::uno::Reference < css::beans::XPropertySet > & xPropSet);
 
 
    static void ExplodeFieldMasterName(
        std::u16string_view sMasterName, 
        OUString& sFieldType,        
        OUString& sVarName);         
 
    static OUString MakeFootnoteRefName(sal_Int16 nSeqNo);
 
    static OUString MakeSequenceRefName(sal_Int16 nSeqNo,
                                              std::u16string_view rSeqName);
 
    std::unique_ptr<XMLPropertyState> pCombinedCharactersPropertyState;
 
};
 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */