note
	description: "Table of contents converter."
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date$"
	revision: "$Revision$"

deferred class
	TABLE_OF_CONTENTS_FORMATTER

inherit		
	TABLE_OF_CONTENTS_CONSTANTS
	
feature -- Creation

	make (a_toc: TABLE_OF_CONTENTS)	
			-- Create
		require
			toc_not_void: a_toc /= Void
		do
			toc := a_toc
		ensure
			has_toc: toc /= Void
		end
		
feature -- Access

	toc: TABLE_OF_CONTENTS
			-- Toc to convert
			
	text: STRING
			-- Text
		deferred
		end
		
feature -- Processing

	processed_text: STRING
			-- Text after processing `toc'
		do
			if toc.has_child then
				from
					create Result.make_empty
					toc.children.start
				until
					toc.children.after
				loop
					Result.append (node_text (toc.children.item))
					toc.children.forth
				end
			end			
		end

	node_text (a_node: TABLE_OF_CONTENTS_NODE):STRING
			-- Text for `a_node'
		require
			node_not_void: a_node /= Void
		deferred			
		end		

invariant
	has_toc: toc /= Void

note
	copyright:	"Copyright (c) 1984-2006, Eiffel Software"
	license:	"GPL version 2 (see http://www.eiffel.com/licensing/gpl.txt)"
	licensing_options:	"http://www.eiffel.com/licensing"
	copying: "[
			This file is part of Eiffel Software's Eiffel Development Environment.
			
			Eiffel Software's Eiffel Development Environment is free
			software; you can redistribute it and/or modify it under
			the terms of the GNU General Public License as published
			by the Free Software Foundation, version 2 of the License
			(available at the URL listed under "license" above).
			
			Eiffel Software's Eiffel Development Environment 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 General Public License for more details.
			
			You should have received a copy of the GNU General Public
			License along with Eiffel Software's Eiffel Development
			Environment; if not, write to the Free Software Foundation,
			Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
		]"
	source: "[
			 Eiffel Software
			 356 Storke Road, Goleta, CA 93117 USA
			 Telephone 805-685-1006, Fax 805-685-6869
			 Website http://www.eiffel.com
			 Customer support http://support.eiffel.com
		]"
end -- class TABLE_OF_CONTENTS_FORMATTER