diff options
Diffstat (limited to 'autodoc/inc/ary/doc')
-rw-r--r-- | autodoc/inc/ary/doc/d_docu.hxx | 2 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/d_hypertext.hxx | 64 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/d_namedlist.hxx | 116 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/d_oldcppdocu.hxx | 2 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/d_parametrized.hxx | 5 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/d_struct.hxx | 90 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/d_summary.hxx | 110 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/d_unit.hxx | 99 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/ht/dht_component.hxx | 99 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/ht/dht_html.hxx | 75 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/ht/dht_link2ce.hxx | 76 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/ht/dht_link2param.hxx | 74 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/ht/dht_link2unknown.hxx | 79 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/ht/dht_link2url.hxx | 79 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/ht/dht_plain.hxx | 70 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/ht/dht_processor.hxx | 220 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/ht/dht_stream.hxx | 166 | ||||
-rw-r--r-- | autodoc/inc/ary/doc/ht/dht_white.hxx | 122 |
18 files changed, 0 insertions, 1548 deletions
diff --git a/autodoc/inc/ary/doc/d_docu.hxx b/autodoc/inc/ary/doc/d_docu.hxx index 426ab06900c6..11a9c6533029 100644 --- a/autodoc/inc/ary/doc/d_docu.hxx +++ b/autodoc/inc/ary/doc/d_docu.hxx @@ -53,8 +53,6 @@ class Documentation : public csv::ConstProcessorClient { public: Documentation(); - explicit Documentation( - DYN Node & pass_data); ~Documentation(); // OPERATIONS void Clear(); diff --git a/autodoc/inc/ary/doc/d_hypertext.hxx b/autodoc/inc/ary/doc/d_hypertext.hxx deleted file mode 100644 index e8ddb49ddf2c..000000000000 --- a/autodoc/inc/ary/doc/d_hypertext.hxx +++ /dev/null @@ -1,64 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: d_hypertext.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DOC_D_HYPERTEXT_HXX -#define ARY_DOC_D_HYPERTEXT_HXX - -// USED SERVICES -#include <ary/doc/ht/dht_component.hxx> - -namespace csv -{ - class ProcessorIfc; -} - - - - -namespace ary -{ -namespace doc -{ - - -typedef std::vector<ht::Component> HyperText; - -void Accept( - const HyperText & i_text, - csv::ProcessorIfc & io_processor ); - -const HyperText & NullText(); - - - - -} // namspace doc -} // namspace ary -#endif diff --git a/autodoc/inc/ary/doc/d_namedlist.hxx b/autodoc/inc/ary/doc/d_namedlist.hxx deleted file mode 100644 index c60c847b3a8c..000000000000 --- a/autodoc/inc/ary/doc/d_namedlist.hxx +++ /dev/null @@ -1,116 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: d_namedlist.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DOC_D_NAMEDLIST_HXX -#define ARY_DOC_D_NAMEDLIST_HXX - -// BASE CLASSES -#include <ary/doc/d_node.hxx> - -// USED SERVICES - - - - -namespace ary -{ -namespace doc -{ - - -/** Represents a list of documentation elements of the same type, which - are accessible by their names as a key. - - Actually it is not necessary (by the interface of the class) that - all elements have the same type, but that is its intended purpose - and other uses should be carefully reconsidered. - - @example - Elements could be for example a list of base classes or parameters - which are just a list on one hand, but may be accessed via the name - of the base class/parameter as well. - -*/ -class NamedList : public Node -{ - public: - enum E_HandleDuplicateNames - { - hdn_normal = 0, - hdn_put_together, - hdn_keep_only_first - }; - - // LIFECYCLE - explicit NamedList( - nodetype::id i_id ); - virtual ~NamedList(); - - // OPERATORS - const Node * operator[]( - const String & i_name ) const; - // OPERATIONS - /** When Node name already exists, the new ->Node is discarded. - */ - void Add_Node( - const String & i_name, - DYN Node & pass_Element, - E_HandleDuplicateNames - eHandleDuplicateNames = hdn_normal ); - private: - // Interface csv::ConstProcessorClient: - virtual void do_Accept( - csv::ProcessorIfc & io_processor ) const; - // Locals - void AddNode_normal( - const String & i_name, - DYN Node & pass_Element ); - void AddNode_put_together( - const String & i_name, - DYN Node & pass_Element ); - void AddNode_keep_only_first( - const String & i_name, - DYN Node & pass_Element ); - - // DATA - /** aNames is built exactly parallel to ->aElements. Each - element of aNames contains the key to the corresponding - ->Node in ->aElements. - */ - StringVector aNames; - NodeList aElements; -}; - - - - -} // doc -} // ary -#endif diff --git a/autodoc/inc/ary/doc/d_oldcppdocu.hxx b/autodoc/inc/ary/doc/d_oldcppdocu.hxx index dbeceb2afce3..33f15663a2f3 100644 --- a/autodoc/inc/ary/doc/d_oldcppdocu.hxx +++ b/autodoc/inc/ary/doc/d_oldcppdocu.hxx @@ -100,8 +100,6 @@ class OldCppDocu : public Node virtual bool IsInternal() const; virtual bool IsInterface() const; - static const OldCppDocu & - Null_(); private: // Interface csv::ConstProcessorClient: virtual void do_Accept( diff --git a/autodoc/inc/ary/doc/d_parametrized.hxx b/autodoc/inc/ary/doc/d_parametrized.hxx index 9938a099a35b..93337794ebfb 100644 --- a/autodoc/inc/ary/doc/d_parametrized.hxx +++ b/autodoc/inc/ary/doc/d_parametrized.hxx @@ -34,11 +34,6 @@ // USED SERVICES // BASE CLASSES #include <ary/doc/d_node.hxx> - // OTHER -#include <ary/doc/d_hypertext.hxx> - - - namespace ary { diff --git a/autodoc/inc/ary/doc/d_struct.hxx b/autodoc/inc/ary/doc/d_struct.hxx deleted file mode 100644 index fd803234aa70..000000000000 --- a/autodoc/inc/ary/doc/d_struct.hxx +++ /dev/null @@ -1,90 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: d_struct.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DOC_D_STRUCT_HXX -#define ARY_DOC_D_STRUCT_HXX - -// USED SERVICES - // BASE CLASSES -#include <ary/doc/d_node.hxx> - - - - -namespace ary -{ -namespace doc -{ - - -/** Represents a documentation structure whose elements - are accessible by a slot id. - - @attention - Maximum possible number of slots is 254. -*/ -class Struct : public Node -{ - public: - typedef nodetype::id slot_id; - - // LIFECYCLE - explicit Struct( - nodetype::id i_type ); - virtual ~Struct(); - - // OPERATIONS - /** Sorts the new node into the right slot. - - @return pass_node - */ - Node & Add_Node( - DYN Node & pass_node ); - - // INQUIRY - const Node * Slot( - slot_id i_slot ) const; - // ACCESS - Node * Slot( - slot_id i_slot ); - private: - // Interface csv::ConstProcessorClient: - virtual void do_Accept( - csv::ProcessorIfc & io_processor ) const; - // DATA - NodeList aElements; -}; - - - - -} // namespace doc -} // namespace ary -#endif diff --git a/autodoc/inc/ary/doc/d_summary.hxx b/autodoc/inc/ary/doc/d_summary.hxx deleted file mode 100644 index 12ea12de8f2f..000000000000 --- a/autodoc/inc/ary/doc/d_summary.hxx +++ /dev/null @@ -1,110 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: d_summary.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DOC_D_SUMMARY_HXX -#define ARY_DOC_D_SUMMARY_HXX - -// BASE CLASSES -#include <ary/doc/d_node.hxx> -// USED SERVICES -#include <ary/doc/d_hypertext.hxx> - - - - -namespace ary -{ -namespace doc -{ - - -/** The summary of a documentation block. - - The summary can be: - - the first paragraph of a description (standard), - which should be contained within 2 lines, - - else the first three lines of the description followed by a "(...)". - - If there is no description, first the @return unit will be chosen, if - both are not there, the @resp unit, else the first unit of the docu. - - With an explicit @summary unit the summary can be forced to be longer than - 3 lines. -*/ -class Summary : public Node -{ - public: - // LIFECYCLE - Summary( - nodetype::id i_slot ); - virtual ~Summary(); - - // INQUIRY - const HyperText & Text() const; - bool IsComplete() const; - nodetype::id Origin() const; - - // ACESS - void Set( - const HyperText & i_text, - bool i_isIncomplete, - nodetype::id i_origin ); - private: - // Interface csv::ConstProcessorClient: - virtual void do_Accept( - csv::ProcessorIfc & io_processor ) const; - // DATA - const HyperText * pText; - bool bIncomplete; - nodetype::id nOrigin; /// For example from: description, @return, @responsibility. -}; - - - - -// IMPLEMENTATION -inline bool -Summary::IsComplete() const -{ - return bIncomplete; -} - -inline nodetype::id -Summary::Origin() const -{ - return nOrigin; -} - - - - -} // namespace doc -} // namespace ary -#endif diff --git a/autodoc/inc/ary/doc/d_unit.hxx b/autodoc/inc/ary/doc/d_unit.hxx deleted file mode 100644 index 3d1894375ab4..000000000000 --- a/autodoc/inc/ary/doc/d_unit.hxx +++ /dev/null @@ -1,99 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: d_unit.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DOC_D_UNIT_HXX -#define ARY_DOC_D_UNIT_HXX - -// BASE CLASSES -#include <ary/doc/d_node.hxx> - -// USED SERVICES -#include <ary/doc/d_hypertext.hxx> - - - - -namespace ary -{ -namespace doc -{ - - -/** A documentation with a title and a text. - - @example - ReturnValue - The number of items counted. -*/ -class Unit : public Node -{ - public: - - // LIFECYCLE - explicit Unit( - nodetype::id i_id ); - virtual ~Unit(); - - // INQUIRY - const HyperText & Doc() const; - - // ACESS - HyperText & Doc(); - - private: - // Interface csv::ConstProcessorClient: - virtual void do_Accept( - csv::ProcessorIfc & io_processor ) const; - // DATA - HyperText aDoc; -}; - - - - -// IMPLEMENTATION -inline const HyperText & -Unit::Doc() const -{ - return aDoc; -} - -inline HyperText & -Unit::Doc() -{ - return aDoc; -} - - - - -} // namespace doc -} // namespace ary -#endif diff --git a/autodoc/inc/ary/doc/ht/dht_component.hxx b/autodoc/inc/ary/doc/ht/dht_component.hxx deleted file mode 100644 index 60a7e6c49a7a..000000000000 --- a/autodoc/inc/ary/doc/ht/dht_component.hxx +++ /dev/null @@ -1,99 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: dht_component.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DHT_COMPONENT_HXX -#define ARY_DHT_COMPONENT_HXX - - - - -namespace ary -{ -namespace doc -{ -namespace ht -{ - class Interpreter; - class Processor; - - -/** Interface for components of a ->HyperText. - - This may be a text, whitespace or link etc. -*/ -class Component -{ - // COPYABLE - public: - Component(); - explicit Component( - const Interpreter & i_interpreter ); - Component( - const Interpreter & i_interpreter, - const String & i_data ); - ~Component(); - - void Accept( - Processor & io_processor ) const; - - const Interpreter & AssociatedInterpreter() const; - const String & Data() const; - - private: - // DATA - String aData; - const Interpreter * pInterpreter; -}; - - - - -// IMPLEMENTATION - -inline const Interpreter & -Component::AssociatedInterpreter() const -{ - csv_assert(pInterpreter != 0); - return *pInterpreter; -} - -inline const String & -Component::Data() const -{ - return aData; -} - - - - -} // namespace ht -} // namespace doc -} // namespace ary -#endif diff --git a/autodoc/inc/ary/doc/ht/dht_html.hxx b/autodoc/inc/ary/doc/ht/dht_html.hxx deleted file mode 100644 index d00c684ac516..000000000000 --- a/autodoc/inc/ary/doc/ht/dht_html.hxx +++ /dev/null @@ -1,75 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: dht_html.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DHT_HTML_HXX -#define ARY_DHT_HTML_HXX -// KORR_DEPRECATED_3.0 -// There will be only one kind of documentation in the future -// that gracefully recognizes HTML, but also does simple formatting -// without it. - -// BASE CLASSES -#include <ary/doc/ht/dht_interpreter.hxx> - - - - -namespace ary -{ -namespace doc -{ -namespace ht -{ - class Component; - - -/** Documentation text in HTML format. -*/ -class HtmlText : public Interpreter -{ - public: - virtual ~HtmlText(); - - static Component Create_Component_( - const String & i_text ); - private: - // Interface Interpreter: - virtual void do_Accept( - Processor & io_processor, - const String & i_data ) const; -}; - - - - -} // namespace ht -} // namespace doc -} // namespace ary -#endif diff --git a/autodoc/inc/ary/doc/ht/dht_link2ce.hxx b/autodoc/inc/ary/doc/ht/dht_link2ce.hxx deleted file mode 100644 index 4329fcf3ad5d..000000000000 --- a/autodoc/inc/ary/doc/ht/dht_link2ce.hxx +++ /dev/null @@ -1,76 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: dht_link2ce.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DOC_DHT_LINK2CE_HXX -#define ARY_DOC_DHT_LINK2CE_HXX - -// BASE CLASSES -#include <ary/doc/ht/dht_interpreter.hxx> - - - - -namespace ary -{ -namespace doc -{ -namespace ht -{ - class Component; - - -/** Link to an ->::ary::Entity. -*/ -class Link2Ce : public Interpreter -{ - public: - virtual ~Link2Ce(); - - static Component Create_Component_( - const String & i_ceAbsolutePath, - const String & i_display ); - static void Resolve_( - String & o_absolutePath, - String & o_display, - const String & i_data); - private: - // Interface Interpreter: - virtual void do_Accept( - Processor & io_processor, - const String & i_data ) const; -}; - - - - -} // namespace ht -} // namespace doc -} // namespace ary -#endif diff --git a/autodoc/inc/ary/doc/ht/dht_link2param.hxx b/autodoc/inc/ary/doc/ht/dht_link2param.hxx deleted file mode 100644 index 07906ac4d089..000000000000 --- a/autodoc/inc/ary/doc/ht/dht_link2param.hxx +++ /dev/null @@ -1,74 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: dht_link2param.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DHT_LINK2PARAM_HXX -#define ARY_DHT_LINK2PARAM_HXX - -// BASE CLASSES -#include <ary/doc/ht/dht_interpreter.hxx> - -// USED SERVICES - - - - -namespace ary -{ -namespace doc -{ -namespace ht -{ - class Component; - - -/** Interpretes a link to a parameter of the just described function. -*/ -class Link2Param : public Interpreter -{ - public: - virtual ~Link2Param(); - - static Component Create_Component_( - const String & i_parameterName, - const String & i_display ); - private: - // Interface Interpreter: - virtual void do_Accept( - Processor & io_processor, - const String & i_data ) const; -}; - - - - -} // namespace ht -} // namespace doc -} // namespace ary -#endif diff --git a/autodoc/inc/ary/doc/ht/dht_link2unknown.hxx b/autodoc/inc/ary/doc/ht/dht_link2unknown.hxx deleted file mode 100644 index ec6ed3d88d05..000000000000 --- a/autodoc/inc/ary/doc/ht/dht_link2unknown.hxx +++ /dev/null @@ -1,79 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: dht_link2unknown.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DHT_LINK2UNKNOWN_HXX -#define ARY_DHT_LINK2UNKNOWN_HXX - -// BASE CLASSES -#include <ary/doc/ht/dht_interpreter.hxx> - -// USED SERVICES - - - - -namespace ary -{ -namespace doc -{ -namespace ht -{ - class Component; - - -/** Interpretes a link in documentation to a yet unknown target. -*/ -class Link2Unknown : public Interpreter -{ - public: - virtual ~Link2Unknown(); - - static Component Create_Component_( - const String & i_typeText, - const String & i_display ); - static void Resolve_( - String & o_typeText, - String & o_display, - const String & i_data); - private: - // Interface Interpreter: - virtual void do_Accept( - Processor & io_processor, - const String & i_data ) const; -}; - - - - - -} // namespace ht -} // namespace doc -} // namespace ary -#endif diff --git a/autodoc/inc/ary/doc/ht/dht_link2url.hxx b/autodoc/inc/ary/doc/ht/dht_link2url.hxx deleted file mode 100644 index e153fc0c9fde..000000000000 --- a/autodoc/inc/ary/doc/ht/dht_link2url.hxx +++ /dev/null @@ -1,79 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: dht_link2url.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DHT_LINK2URL_HXX -#define ARY_DHT_LINK2URL_HXX - -// BASE CLASSES -#include <ary/doc/ht/dht_interpreter.hxx> - -// USED SERVICES - - - - -namespace ary -{ -namespace doc -{ -namespace ht // Hypertext -{ - class Component; - - - -/** Interpretes a html link within a documentation text. -*/ -class Link2Url : public Interpreter -{ - public: - virtual ~Link2Url(); - - static Component Create_Component_( - const String & i_url, - const String & i_display ); - static void Resolve_( - String & o_url, - String & o_display, - const String & i_data); - private: - // Interface Interpreter: - virtual void do_Accept( - Processor & io_processor, - const String & i_data ) const; -}; - - - - -} // namespace ht -} // namespace doc -} // namespace ary -#endif diff --git a/autodoc/inc/ary/doc/ht/dht_plain.hxx b/autodoc/inc/ary/doc/ht/dht_plain.hxx index 7ce9cf29a159..8b137891791f 100644 --- a/autodoc/inc/ary/doc/ht/dht_plain.hxx +++ b/autodoc/inc/ary/doc/ht/dht_plain.hxx @@ -1,71 +1 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: dht_plain.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DHT_PLAIN_HXX -#define ARY_DHT_PLAIN_HXX - -// BASE CLASSES -#include <ary/doc/ht/dht_interpreter.hxx> - - - - -namespace ary -{ -namespace doc -{ -namespace ht -{ - class Component; - - -/** Documentation text, simple ASCII. -*/ -class PlainText : public Interpreter -{ - public: - virtual ~PlainText(); - - static Component Create_Component_( - const String & i_text ); - private: - // Interface Interpreter: - virtual void do_Accept( - Processor & io_processor, - const String & i_data ) const; -}; - - - - -} // namespace ht -} // namespace doc -} // namespace ary -#endif diff --git a/autodoc/inc/ary/doc/ht/dht_processor.hxx b/autodoc/inc/ary/doc/ht/dht_processor.hxx deleted file mode 100644 index f324aa967e33..000000000000 --- a/autodoc/inc/ary/doc/ht/dht_processor.hxx +++ /dev/null @@ -1,220 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: dht_processor.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DHT_PROCESSOR_HXX -#define ARY_DHT_PROCESSOR_HXX - -// BASE CLASSES -#include <cosv/tpl/processor.hxx> - -// USED SERVICES -#include <ary/doc/d_hypertext.hxx> - - - - -namespace ary -{ -namespace doc -{ -namespace ht -{ - class PlainText; - class HtmlText; - - class Link2Ce; - class Link2Url; - class Link2Unknown; - class Link2Param; - - class Blank; - class Indentation; - class NewParagraph; - class SummarySeparator; - - -/** Interface for processing {->Component}s of a ->HyperText with - the visitor pattern. -*/ -class Processor : public csv::ProcessorIfc, - public csv::ConstProcessor<HyperText> -{ - public: - virtual ~Processor() {} - - using csv::ConstProcessor<HyperText>::Process; - - // Texts - void Process( - const PlainText & i_interpreter, - const String & i_data ); - void Process( - const HtmlText & i_interpreter, - const String & i_data ); - // Links - void Process( - const Link2Ce & i_interpreter, - const String & i_data ); - void Process( - const Link2Url & i_interpreter, - const String & i_data ); - void Process( - const Link2Unknown & - i_interpreter, - const String & i_data ); - void Process( - const Link2Param & i_interpreter, - const String & i_data ); - // Explicit Whitespace - void Process( - const Blank & i_interpreter ); - void Process( - const Indentation & i_interpreter, - const String & i_data ); - void Process( - const NewParagraph & - i_interpreter ); - void Process( - const SummarySeparator & - i_interpreter ); - private: - // Interface csv::ConstProcessor<HyperText>: - virtual void do_Process( - const HyperText & i_cient ); - // Locals - virtual void do_Process( - const PlainText & i_interpreter, - const String & i_data ) = 0; - virtual void do_Process( - const HtmlText & i_interpreter, - const String & i_data ) = 0; - virtual void do_Process( - const Link2Ce & i_interpreter, - const String & i_data ) = 0; - virtual void do_Process( - const Link2Url & i_interpreter, - const String & i_data ) = 0; - virtual void do_Process( - const Link2Unknown & - i_interpreter, - const String & i_data ) = 0; - virtual void do_Process( - const Link2Param & i_interpreter, - const String & i_data ) = 0; - virtual void do_Process( - const Blank & i_interpreter ) = 0; - virtual void do_Process( - const Indentation & i_interpreter, - const String & i_data ) = 0; - virtual void do_Process( - const NewParagraph & - i_interpreter ) = 0; - virtual void do_Process( - const SummarySeparator & - i_interpreter ) = 0; -}; - - - -// IMPLEMENTATION -inline void -Processor::Process( const PlainText & i_interpreter, - const String & i_data ) -{ - do_Process(i_interpreter, i_data); -} - -inline void -Processor::Process( const HtmlText & i_interpreter, - const String & i_data ) -{ - do_Process(i_interpreter, i_data); -} - -inline void -Processor::Process( const Link2Ce & i_interpreter, - const String & i_data ) -{ - do_Process(i_interpreter, i_data); -} - -inline void -Processor::Process( const Link2Url & i_interpreter, - const String & i_data ) -{ - do_Process(i_interpreter, i_data); -} - -inline void -Processor::Process( const Link2Unknown & i_interpreter, - const String & i_data ) -{ - do_Process(i_interpreter, i_data); -} - -inline void -Processor::Process( const Link2Param & i_interpreter, - const String & i_data ) -{ - do_Process(i_interpreter, i_data); -} - -inline void -Processor::Process( const Blank & i_interpreter ) -{ - do_Process(i_interpreter); -} - -inline void -Processor::Process( const Indentation & i_interpreter, - const String & i_data ) -{ - do_Process(i_interpreter, i_data); -} - -inline void -Processor::Process( const NewParagraph & i_interpreter ) -{ - do_Process(i_interpreter); -} - -inline void -Processor::Process( const SummarySeparator & i_interpreter ) -{ - do_Process(i_interpreter); -} - - - - -} // namespace ht -} // namespace doc -} // namespace ary -#endif diff --git a/autodoc/inc/ary/doc/ht/dht_stream.hxx b/autodoc/inc/ary/doc/ht/dht_stream.hxx deleted file mode 100644 index b45d7d7692b8..000000000000 --- a/autodoc/inc/ary/doc/ht/dht_stream.hxx +++ /dev/null @@ -1,166 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: dht_stream.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DOC_DHT_STREAM_HXX -#define ARY_DOC_DHT_STREAM_HXX - -// USED SERVICES -#include <ary/doc/d_hypertext.hxx> - - - -namespace ary -{ -namespace doc -{ -namespace ht -{ - class Stream; - - -typedef void (* F_StreamModifier)(Stream&); - -/// Causes the buffer in ->io_stream to be flushed. -void flush( - Stream & io_stream ); -/// Adds a newline. -void newline( - Stream & io_stream ); -/// Adds a single blank char. -void blank( - Stream & io_stream ); -/// Modifies ->Stream to plain text mode. -void plain( - Stream & io_stream ); -/// Modifies ->Stream to html text mode. -void html( - Stream & io_stream ); - - - - -/** Interface to write items into a ->HyperText. - - Text can be intepreted as plain ASCII or as HTML. The default - is plain ASCII. - Also you can add links and can specify the link's label. - If no label is provided for a link, the most specific part of the - link's name will be used. - - - @example - using ary::doc::HyperText; - using ary::doc::ht::Stream; - - Stream aWriter; - HyperText aText; - StreamGuard aGuard(aWriter,aText); - - Ce_id nId = i_ceid; - aWriter << "Hello," << newline; - aWriter.Add_Link2Ce(GetAbsolutePath(nId), "SomeCodeEntity") - aWriter << " will be transfered." << newline; - aWriter Add_Link2Param("io_someParameter"); - aWriter << " shows something else." - << flush; -*/ -class Stream -{ - NON_COPYABLE(Stream); - - public: - /// Marks the mode how documentation text is interpreted. - enum E_TextMode - { - tm_plain, - tm_html - }; - - Stream( - HyperText & o_Receiver, - E_TextMode i_initialTextMode = tm_plain); - /// Also flushes the stream to the connected ->HyperText, if any. - virtual ~Stream(); - - Stream & operator<<( - F_StreamModifier i_modifier ); - /// Inserts text. - Stream & operator<<( - const char * i_text ); - /// Inserts text. - Stream & operator<<( - const String & i_text ); - - void Add_Indentation( - uintt i_count ); - - void Add_Link2Ce( - const String & i_absolutePath, - const String & i_display = String::Null_() ); - void Add_Link2Unknown( - const String & i_type, - const String & i_display = String::Null_() ); - void Add_Link2Url( - const String & i_url, - const String & i_display = String::Null_() ); - void Add_Link2Param( - const String & i_parameter, - const String & i_display = String::Null_() ); - - E_TextMode CurrentMode() const; - - private: - friend void flush(Stream&); - friend void newline(Stream&); - friend void blank(Stream&); - friend void plain(Stream&); - friend void html(Stream&); - - // Locals - typedef void (Stream::*F_TextFlusher)(); - - void Flush(); - void PlainTextFlusher(); - void HtmlTextFlusher(); - - HyperText & Out(); - - // DATA - HyperText & mrOut; - F_TextFlusher mfCurTextFlusher; - StreamStr mText; -}; - - - -} // namspace ht -} // namspace doc -} // namspace ary -#endif diff --git a/autodoc/inc/ary/doc/ht/dht_white.hxx b/autodoc/inc/ary/doc/ht/dht_white.hxx deleted file mode 100644 index b57f857f6ff4..000000000000 --- a/autodoc/inc/ary/doc/ht/dht_white.hxx +++ /dev/null @@ -1,122 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: dht_white.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DHT_WHITE_HXX -#define ARY_DHT_WHITE_HXX - -// BASE CLASSES -#include <ary/doc/ht/dht_interpreter.hxx> - - - - -namespace ary -{ -namespace doc -{ -namespace ht -{ - class Component; - - -/** One blank character in documentation text. -*/ -class Blank : public Interpreter -{ - public: - virtual ~Blank(); - - static Component Create_Component_(); - - private: - // Interface Interpreter: - virtual void do_Accept( - Processor & io_processor, - const String & i_data ) const; -}; - - -/** New paragraph in documentation text. -*/ -class NewParagraph : public Interpreter -{ - public: - virtual ~NewParagraph(); - - static Component Create_Component_(); - - private: - // Interface Interpreter: - virtual void do_Accept( - Processor & io_processor, - const String & i_data ) const; -}; - -/** An indentation, beginning a line, in documentation text. -*/ -class Indentation : public Interpreter -{ - public: - virtual ~Indentation(); - - static Component Create_Component_( - uintt i_size ); - private: - // Interface Interpreter: - virtual void do_Accept( - Processor & io_processor, - const String & i_data ) const; -}; - - -/** The point where the first paragraph ends. Needed, if this text - has to work as a summary for containing the documentation block. -*/ -class SummarySeparator: public Interpreter -{ - public: - virtual ~SummarySeparator(); - - static Component Create_Component_( - bool i_interrupted ); - private: - // Interface Interpreter: - virtual void do_Accept( - Processor & io_processor, - const String & i_data ) const; -}; - - - - -} // namespace ht -} // namespace doc -} // namespace ary -#endif |