summaryrefslogtreecommitdiff
path: root/autodoc/source/display/html/hdimpl.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'autodoc/source/display/html/hdimpl.hxx')
-rw-r--r--autodoc/source/display/html/hdimpl.hxx247
1 files changed, 247 insertions, 0 deletions
diff --git a/autodoc/source/display/html/hdimpl.hxx b/autodoc/source/display/html/hdimpl.hxx
new file mode 100644
index 000000000000..ca882ec4152f
--- /dev/null
+++ b/autodoc/source/display/html/hdimpl.hxx
@@ -0,0 +1,247 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org 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 version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef ADC_DISPLAY_HDIMPL_HXX
+#define ADC_DISPLAY_HDIMPL_HXX
+
+// BASE CLASSES
+#include <udm/html/htmlitem.hxx>
+// USED SERVICES
+#include "easywri.hxx"
+#include <cosv/bstream.hxx>
+#include <ary/ary_disp.hxx>
+#include <ary/cpp/c_namesp.hxx>
+#include <ary/cpp/c_ce.hxx>
+#include "aryattrs.hxx" // For compatibility with earlier times, when those funtions were in this header.
+
+
+namespace ary
+{
+ namespace cpp
+ {
+ class CodeEntity;
+ class Class;
+ class DisplayGate;
+ class Function;
+ class DefineEntity;
+ class OperationSignature;
+ }
+
+ class QualifiedName;
+}
+namespace csi
+{
+ namespace xml
+ {
+ class Element;
+ }
+ namespace html
+ {
+ class Table;
+ }
+}
+
+namespace adcdisp
+{
+ class ParameterTable;
+}
+
+class OuputPage_Environment;
+class Docu_Display;
+
+class HtmlDisplay_Impl
+{
+ public:
+ ~HtmlDisplay_Impl();
+
+ const OuputPage_Environment &
+ Env() const { return *pEnv; }
+
+ // ACCESS
+ OuputPage_Environment &
+ Env() { return *pEnv; }
+ EasyWriter & Easy() { return aWriteHelper; }
+ csi::xml::Element & CurOut() { return aWriteHelper.Out(); }
+
+ protected:
+ HtmlDisplay_Impl(
+ OuputPage_Environment &
+ io_rEnv );
+ private:
+ // DATA
+ OuputPage_Environment *
+ pEnv;
+ EasyWriter aWriteHelper;
+};
+
+
+namespace dshelp
+{
+
+void DisplaySlot(
+ ary::Display & o_rDisplay,
+ const ary::AryGroup &
+ i_rGroup,
+ ary::SlotAccessId i_nSlot );
+
+
+const char * PathUp(
+ uintt i_nLevels );
+const char * PathPerLevelsUp(
+ uintt i_nLevels,
+ const char * i_nPathBelowDestinationLevel );
+
+const char * PathPerRoot(
+ const OuputPage_Environment &
+ i_rEnv,
+ const char * i_sPathFromRootDir );
+const char * PathPerNamespace(
+ const OuputPage_Environment &
+ i_rEnv,
+ const char * i_sPathFromNamespaceDir );
+
+void Create_ChildListLabel(
+ csi::xml::Element & o_rParentElement,
+ const char * i_sLabel );
+DYN csi::html::Table &
+ Create_ChildListTable(
+ const char * i_sTitle );
+
+const char * HtmlFileName(
+ const char * i_sPrefix,
+ const char * i_sEntityName );
+
+inline const char *
+ClassFileName( const char * i_sClassLocalName )
+ { return HtmlFileName( "c-", i_sClassLocalName); }
+inline const char *
+EnumFileName( const char * i_sEnumLocalName )
+ { return HtmlFileName( "e-", i_sEnumLocalName); }
+inline const char *
+TypedefFileName( const char * i_sTypedefLocalName )
+ { return HtmlFileName( "t-", i_sTypedefLocalName); }
+inline const char *
+FileFileName( const char * i_sFileLocalName )
+ { return HtmlFileName( "f-", i_sFileLocalName); }
+
+const char * Path2Class(
+ uintt i_nLevelsUp,
+ const char * i_sClassLocalName );
+
+const char * Path2Child(
+ const char * i_sFileName,
+ const char * i_sSubDir = 0 );
+
+const char * Path2ChildNamespace(
+ const char * i_sLocalName );
+
+String OperationLink(
+ const ary::cpp::Gate & i_gate,
+ const String & i_sOpName,
+ ary::cpp::Ce_id i_nOpId,
+ const char * i_sPrePath = "" );
+const char * DataLink(
+ const String & i_sLocalName,
+ const char * i_sPrePath = "" );
+
+inline String
+OperationLabel( const String & i_sOpName,
+ ary::cpp::Ce_id i_nOpId,
+ const ary::cpp::Gate & i_gate )
+ { return String(OperationLink(i_gate, i_sOpName, i_nOpId) + 1); } // Skip '#' in front.
+inline const char *
+DataLabel( const String & i_sLocalName )
+ { return DataLink(i_sLocalName) + 1; } // Skip '#' in front.
+
+
+void Get_LinkedTypeText(
+ csi::xml::Element & o_rOut,
+ const OuputPage_Environment &
+ i_rEnv,
+ ary::cpp::Type_id i_nId,
+ bool i_bWithAbsolutifier = true );
+
+
+const char * Link2Ce(
+ const OuputPage_Environment &
+ i_rEnv,
+ const ary::cpp::CodeEntity &
+ i_rCe );
+
+const char * Link2CppDefinition(
+ const OuputPage_Environment &
+ i_rEnv,
+ const ary::cpp::DefineEntity &
+ i_rDef );
+
+const ary::cpp::CodeEntity *
+ FindUnambiguousCe(
+ const OuputPage_Environment &
+ i_rEnv,
+ const ary::QualifiedName &
+ i_rQuName,
+ const ary::cpp::Class * i_pJustDocumentedClass );
+
+void ShowDocu_On(
+ csi::xml::Element & o_rOut,
+ Docu_Display & io_rDisplay,
+ const ary::cpp::CppEntity &
+ i_rRE );
+
+void WriteOut_TokenList(
+ csi::xml::Element & o_rOut,
+ const StringVector & i_rTokens,
+ const char * i_sSeparator );
+
+void EraseLeadingSpace(
+ String & io_rStr );
+
+/** @param o_bIsConst
+ *o_bIsConst will be set to true, if o_bIsConst != 0 and function is const.
+ If the function is not const, *o_bIsConst remains unchanged!
+
+ @param o_bIsVirtual
+ The same as o_bIsConst.
+*/
+void WriteOut_LinkedFunctionText(
+ csi::xml::Element & o_rTitleOut,
+ adcdisp::ParameterTable &
+ o_rParameters,
+ const ary::cpp::Function &
+ i_rFunction,
+ const OuputPage_Environment &
+ i_rEnv,
+ bool * o_bIsConst = 0,
+ bool * o_bIsVirtual = 0 );
+
+
+
+} // namespace dshelp
+
+using namespace dshelp;
+
+#endif