From 035c7fabc3b82cbc9a346c11abe2e9462b4c0379 Mon Sep 17 00:00:00 2001
From: Anas Nashif <anas.nashif@intel.com>
Date: Tue, 30 Oct 2012 15:39:57 -0700
Subject: Imported Upstream version 2.8.9

---
 Source/cmDocumentationFormatter.h | 67 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Source/cmDocumentationFormatter.h

(limited to 'Source/cmDocumentationFormatter.h')

diff --git a/Source/cmDocumentationFormatter.h b/Source/cmDocumentationFormatter.h
new file mode 100644
index 000000000..665b9b61a
--- /dev/null
+++ b/Source/cmDocumentationFormatter.h
@@ -0,0 +1,67 @@
+/*============================================================================
+  CMake - Cross Platform Makefile Generator
+  Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
+
+  Distributed under the OSI-approved BSD License (the "License");
+  see accompanying file Copyright.txt for details.
+
+  This software is distributed WITHOUT ANY WARRANTY; without even the
+  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  See the License for more information.
+============================================================================*/
+#ifndef _cmDocumentationFormatter_h
+#define _cmDocumentationFormatter_h
+
+#include "cmStandardIncludes.h"
+
+/** This is just a helper class to make it build with MSVC 6.0.
+Actually the enums and internal classes could directly go into
+cmDocumentation, but then MSVC6 complains in RequestedHelpItem that
+cmDocumentation is an undefined type and so it doesn't know the enums.
+Moving the enums to a class which is then already completely parsed helps
+against this. */
+class cmDocumentationEnums
+{
+public:
+  /** Types of help provided.  */
+  enum Type
+  { None, Usage, Single, SingleModule, SingleProperty, SingleVariable,
+    List, ModuleList, PropertyList, VariableList,
+    Full, Properties, Variables, Modules, CustomModules, Commands,
+    CompatCommands, Copyright, Version, Policies, SinglePolicy };
+
+  /** Forms of documentation output.  */
+  enum Form { TextForm, HTMLForm, ManForm, UsageForm, DocbookForm };
+};
+
+class cmDocumentationSection;
+
+/** Base class for printing the documentation in the various supported
+   formats. */
+class cmDocumentationFormatter
+{
+public:
+  cmDocumentationFormatter();
+  virtual ~cmDocumentationFormatter();
+  void PrintFormatted(std::ostream& os, const char* text);
+
+  virtual cmDocumentationEnums::Form GetForm() const = 0;
+
+  virtual void PrintHeader(const char* /*docname*/,
+                           const char* /*appname*/,
+                           std::ostream& /*os*/) {}
+  virtual void PrintFooter(std::ostream& /*os*/) {}
+  virtual void PrintSection(std::ostream& os,
+                    const cmDocumentationSection& section,
+                    const char* name) = 0;
+  virtual void PrintPreformatted(std::ostream& os, const char* text) = 0;
+  virtual void PrintParagraph(std::ostream& os, const char* text) = 0;
+  virtual void PrintIndex(std::ostream& ,
+                          std::vector<const cmDocumentationSection *>&)
+    {}
+
+  /** Compute a prefix for links into a section (#\<prefix\>_SOMETHING). */
+  std::string ComputeSectionLinkPrefix(std::string const& name);
+};
+
+#endif
-- 
cgit v1.2.3