summaryrefslogtreecommitdiff
path: root/autodoc/source/inc/adc_cl.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'autodoc/source/inc/adc_cl.hxx')
-rw-r--r--autodoc/source/inc/adc_cl.hxx193
1 files changed, 193 insertions, 0 deletions
diff --git a/autodoc/source/inc/adc_cl.hxx b/autodoc/source/inc/adc_cl.hxx
new file mode 100644
index 000000000000..8bcec7df50ce
--- /dev/null
+++ b/autodoc/source/inc/adc_cl.hxx
@@ -0,0 +1,193 @@
+/*************************************************************************
+ *
+ * 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_ADC_CL_HXX
+#define ADC_ADC_CL_HXX
+
+
+
+// USED SERVICES
+ // BASE CLASSES
+#include <cosv/comdline.hxx>
+ // COMPONENTS
+ // PARAMETERS
+
+namespace ary
+{
+ class Repository;
+}
+
+namespace autodoc
+{
+namespace command
+{
+ class Command;
+ class CreateHtml;
+ class SinceTagTransformationData;
+}
+
+
+/** Reads and runs an Autodoc command line.
+*/
+class CommandLine : public csv::CommandLine_Ifc
+{
+ public:
+ // LIFECYCLE
+ CommandLine();
+ ~CommandLine();
+ // OPERATIONS
+ int Run() const;
+
+ // INQUIRY
+ // debugging
+ bool DebugStyle_ShowText() const;
+ bool DebugStyle_ShowStoredObjects() const;
+ bool DebugStyle_ShowTokens() const;
+
+ // @since tags
+ bool DoesTransform_SinceTag() const;
+
+// /// @see command::SinceTagTransformationData::StripSinceTagValue()
+// bool Strip_SinceTagText(
+// String & io_sSinceTagValue ) const;
+
+ /// @see command::SinceTagTransformationData::DisplayOf()
+ const String & DisplayOf_SinceTagValue(
+ const String & i_sVersionNumber ) const;
+
+ // extern IDL links
+ const String & ExternRoot() const { return sExternRoot; }
+ const String & ExternNamespace() const { return sExternNamespace; }
+
+ bool CppUsed() const { return bCpp; }
+ bool IdlUsed() const { return bIdl; }
+
+ // ACCESS
+ static CommandLine &
+ Get_();
+ void Set_ExternRoot(
+ const String & i_s )
+ { sExternRoot = i_s; }
+ void Set_ExternNamespace(
+ const String & i_s )
+ { sExternNamespace = i_s; }
+ ary::Repository & TheRepository() const { csv_assert(pReposy != 0);
+ return *pReposy; }
+ void Set_CppUsed() { bCpp = true; }
+ void Set_IdlUsed() { bIdl = true; }
+
+ private:
+ // Interface cosv::CommandLine_Ifc:
+ virtual void do_Init(
+ int argc,
+ char * argv[] );
+ virtual void do_PrintUse() const;
+ virtual bool inq_CheckParameters() const;
+
+ // Locals
+ typedef StringVector::const_iterator opt_iter;
+ typedef std::vector< DYN command::Command* > CommandList;
+
+ void load_IncludedCommands(
+ StringVector & out,
+ const char * i_filePath );
+
+ void do_clVerbose(
+ opt_iter & it,
+ opt_iter itEnd );
+ void do_clParse(
+ opt_iter & it,
+ opt_iter itEnd );
+ void do_clCreateHtml(
+ opt_iter & it,
+ opt_iter itEnd );
+ void do_clSinceFile(
+ opt_iter & it,
+ opt_iter itEnd );
+
+// void do_clCreateXml(
+// opt_iter & it,
+// opt_iter itEnd );
+// void do_clLoad(
+// opt_iter & it,
+// opt_iter itEnd );
+// void do_clSave(
+// opt_iter & it,
+// opt_iter itEnd );
+
+ void sort_Commands();
+
+ // DATA
+ uintt nDebugStyle;
+ Dyn<command::SinceTagTransformationData>
+ pSinceTransformator;
+
+ CommandList aCommands;
+ bool bInitOk;
+ command::CreateHtml *
+ pCommand_CreateHtml;
+
+ String sExternRoot;
+ String sExternNamespace;
+
+ mutable Dyn<ary::Repository>
+ pReposy;
+ bool bCpp;
+ bool bIdl;
+
+ static CommandLine *
+ pTheInstance_;
+};
+
+
+
+// IMPLEMENTATION
+inline bool
+CommandLine::DebugStyle_ShowText() const
+ { return (nDebugStyle & 2) != 0; }
+inline bool
+CommandLine::DebugStyle_ShowStoredObjects() const
+ { return (nDebugStyle & 4) != 0; }
+inline bool
+CommandLine::DebugStyle_ShowTokens() const
+ { return (nDebugStyle & 1) != 0; }
+
+} // namespace autodoc
+
+
+inline bool
+DEBUG_ShowText()
+ { return autodoc::CommandLine::Get_().DebugStyle_ShowText(); }
+inline bool
+DEBUG_ShowStoring()
+ { return autodoc::CommandLine::Get_().DebugStyle_ShowStoredObjects(); }
+inline bool
+DEBUG_ShowTokens()
+ { return autodoc::CommandLine::Get_().DebugStyle_ShowTokens(); }
+
+#endif
+