Automatic generation produced by ISE Eiffel
indexing
description: "a template based HTML page view, implement a rich set of routines to help generating a result HTML page based on a predefined HTML template."
author: "Peizhu Li, <lip@student.ethz.ch>"
date: "12.01.2007"
revision: "$0.6$"
class
HTML_TEMPLATE_VIEW
create
make,
make_empty
feature {ANY} -- Initialization
make_empty
-- Create an HTML page.
-- (from HTML_PAGE)
do
image := "<HTML>%N</HTML>"
end
feature -- Initialization
make_from_template (fi_n: STRING_8)
-- Create an HTML page from a template whose path name is
-- 'fi'. The template may contains special symbols/words, which
-- will allow smart replacing (see feature 'replace').
-- (from HTML_PAGE)
require -- from HTML_PAGE
path_not_void: fi_n /= Void
local
fi: PLAIN_TEXT_FILE
retried: BOOLEAN
do
if not retried then
create fi.make_open_read (fi_n)
fi.read_stream (fi.count)
image := fi.last_string.twin
fi.close
else
image := "<HTML>Could not read file " + fi_n + ".</HTML>"
end
ensure -- from HTML_PAGE
image_exists: image /= Void
rescue
retried := True
retry
end
feature {NONE} -- Initialization
default_create
-- Process instances of classes with no creation clause.
-- (Default: do nothing.)
-- (from ANY)
do
end
feature -- Access
generating_type: STRING_8
-- Name of current object's generating type
-- (type of which it is a direct instance)
-- (from ANY)
external
"built_in"
ensure -- from ANY
generating_type_not_void: Result /= Void
generating_type_not_empty: not Result.is_empty
end
generator: STRING_8
-- Name of current object's generating class
-- (base class of the type of which it is a direct instance)
-- (from ANY)
external
"built_in"
ensure -- from ANY
generator_not_void: Result /= Void
generator_not_empty: not Result.is_empty
end
out: STRING_8
-- Usable copy of the output.
-- (from HTML_PAGE)
do
if image /= Void then
Result := image.twin
end
ensure -- from ANY
out_not_void: Result /= Void
end
feature -- Comparison
frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
-- Are `some' and `other' either both void
-- or attached to isomorphic object structures?
-- (from ANY)
do
if some = Void then
Result := other = Void
else
Result := other /= Void and then some.is_deep_equal (other)
end
ensure -- from ANY
shallow_implies_deep: standard_equal (some, other) implies Result
both_or_none_void: (some = Void) implies (Result = (other = Void))
same_type: (Result and (some /= Void)) implies some.same_type (other)
symmetric: Result implies deep_equal (other, some)
end
frozen equal (some: ANY; other: like arg #1): BOOLEAN
-- Are `some' and `other' either both void or attached
-- to objects considered equal?
-- (from ANY)
do
if some = Void then
Result := other = Void
else
Result := other /= Void and then some.is_equal (other)
end
ensure -- from ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))
end
frozen is_deep_equal (other: like Current): BOOLEAN
-- Are `Current' and `other' attached to isomorphic object structures?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
external
"built_in"
ensure -- from ANY
shallow_implies_deep: standard_is_equal (other) implies Result
same_type: Result implies same_type (other)
symmetric: Result implies other.is_deep_equal (Current)
end
is_equal (other: like Current): BOOLEAN
-- Is `other' attached to an object considered
-- equal to current object?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
do
Result := standard_is_equal (other)
ensure -- from ANY
symmetric: Result implies other.is_equal (Current)
consistent: standard_is_equal (other) implies Result
end
frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
-- Are `some' and `other' either both void or attached to
-- field-by-field identical objects of the same type?
-- Always uses default object comparison criterion.
-- (from ANY)
do
if some = Void then
Result := other = Void
else
Result := other /= Void and then some.standard_is_equal (other)
end
ensure -- from ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))
end
frozen standard_is_equal (other: like Current): BOOLEAN
-- Is `other' attached to an object of the same type
-- as current object, and field-by-field identical to it?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
external
"built_in"
ensure -- from ANY
same_type: Result implies same_type (other)
symmetric: Result implies other.standard_is_equal (Current)
end
feature -- Status report
conforms_to (other: ANY): BOOLEAN
-- Does type of current object conform to type
-- of `other' (as per Eiffel: The Language, chapter 13)?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
external
"built_in"
end
same_type (other: ANY): BOOLEAN
-- Is type of current object identical to type of `other'?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
external
"built_in"
ensure -- from ANY
definition: Result = (conforms_to (other) and other.conforms_to (Current))
end
feature -- Duplication
frozen clone (other: ANY): like other
obsolete "Use `twin' instead."
-- Void if `other' is void; otherwise new object
-- equal to `other'
--
-- For non-void `other', clone calls copy;
-- to change copying/cloning semantics, redefine copy.
-- (from ANY)
do
if other /= Void then
Result := other.twin
end
ensure -- from ANY
equal: equal (Result, other)
end
copy (other: like Current)
-- Update current object using fields of object attached
-- to `other', so as to yield equal objects.
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
type_identity: same_type (other)
external
"built_in"
ensure -- from ANY
is_equal: is_equal (other)
end
frozen deep_clone (other: ANY): like other
obsolete "Use `deep_twin' instead."
-- Void if `other' is void: otherwise, new object structure
-- recursively duplicated from the one attached to `other'
-- (from ANY)
do
if other /= Void then
Result := other.deep_twin
end
ensure -- from ANY
deep_equal: deep_equal (other, Result)
end
frozen deep_copy (other: like Current)
-- Effect equivalent to that of:
-- copy (`other' . deep_twin)
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
do
copy (other.deep_twin)
ensure -- from ANY
deep_equal: deep_equal (Current, other)
end
frozen deep_twin: like Current
-- New object structure recursively duplicated from Current.
-- (from ANY)
external
"built_in"
ensure -- from ANY
deep_twin_not_void: Result /= Void
deep_equal: deep_equal (Current, Result)
end
frozen standard_clone (other: ANY): like other
obsolete "Use `standard_twin' instead."
-- Void if `other' is void; otherwise new object
-- field-by-field identical to `other'.
-- Always uses default copying semantics.
-- (from ANY)
do
if other /= Void then
Result := other.standard_twin
end
ensure -- from ANY
equal: standard_equal (Result, other)
end
frozen standard_copy (other: like Current)
-- Copy every field of `other' onto corresponding field
-- of current object.
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
type_identity: same_type (other)
external
"built_in"
ensure -- from ANY
is_standard_equal: standard_is_equal (other)
end
frozen standard_twin: like Current
-- New object field-by-field identical to `other'.
-- Always uses default copying semantics.
-- (from ANY)
local
l_temp: BOOLEAN
do
l_temp := {ISE_RUNTIME}.check_assert (False)
Result ?= {ISE_RUNTIME}.c_standard_clone ($Current)
Result.standard_copy (Current)
l_temp := {ISE_RUNTIME}.check_assert (l_temp)
ensure -- from ANY
standard_twin_not_void: Result /= Void
equal: standard_equal (Result, Current)
end
frozen twin: like Current
-- New object equal to `Current'
-- twin calls copy; to change copying/twining semantics, redefine copy.
-- (from ANY)
local
l_temp: BOOLEAN
do
l_temp := {ISE_RUNTIME}.check_assert (False)
Result ?= {ISE_RUNTIME}.c_standard_clone ($Current)
Result.copy (Current)
l_temp := {ISE_RUNTIME}.check_assert (l_temp)
ensure -- from ANY
twin_not_void: Result /= Void
is_equal: Result.is_equal (Current)
end
feature -- Basic operations
frozen default: like Current
-- Default value of object's type
-- (from ANY)
do
end
frozen default_pointer: POINTER
-- Default value of type `POINTER'
-- (Avoid the need to write `p'.default for
-- some `p' of type `POINTER'.)
-- (from ANY)
do
end
default_rescue
-- Process exception for routines with no Rescue clause.
-- (Default: do nothing.)
-- (from ANY)
do
end
frozen do_nothing
-- Execute a null action.
-- (from ANY)
do
end
feature {NONE} -- Implementation
image: STRING_8
-- Image corresponding to Current.
-- (from HTML_PAGE)
feature -- Basic Operations
add_html_code (s: STRING_8)
-- Add html code 's'.
-- (from HTML_PAGE)
require -- from HTML_PAGE
code_exists: s /= Void
local
i: INTEGER_32
s1: STRING_8
do
i := image.substring_index ("</HTML", 1)
if i = 0 then
i := image.substring_index ("</html", 1)
end
check
found_tag: i > 0
end
s1 := image.substring (i, i + 6)
s.append (s1)
image.replace_substring_all (s1, s)
end
insert_hidden_field (name, value: STRING_8)
-- Insert hidden field with name 'name' and value 'value'.
-- (from HTML_PAGE)
require -- from HTML_PAGE
has_form: out.substring_index ("</form>", 1) > 0 or out.substring_index ("</FORM>", 1) > 0
local
i: INTEGER_32
do
i := image.substring_index ("</form>", 1)
if i < 1 then
i := image.substring_index ("</FORM>", 1)
if i > 0 then
image.replace_substring_all ("</FORM>", "<INPUT type=hidden name=%"" + name + "%" value=%"" + value + "%">%N</FORM>")
end
else
image.replace_substring_all ("</form>", "<input type=hidden name=%"" + name + "%" value=%"" + value + "%">%N</form>")
end
end
replace_marker (a_marker, s: STRING_8)
-- Replace marker 'a_marker' by string 's'
-- within the template.
-- Do nothing if it does not exist.
-- (from HTML_PAGE)
require -- from HTML_PAGE
not_void: a_marker /= Void and s /= Void
do
image.replace_substring_all (a_marker, s)
end
feature -- Commands
cleanup_tags
-- remove the comments from the html code.
local
start_index, end_index: INTEGER_32
do
from
start_index := 1
until
start_index = 0
loop
start_index := image.substring_index ("{#", start_index)
if start_index > 0 then
end_index := image.substring_index ("#}", start_index + 2)
if end_index > 0 then
image.remove_substring (start_index, end_index + 1)
else
start_index := start_index + 2
end
end
end
end
cleanup_unused_sections
-- remove the comments from the html code.
local
start_index, end_index, marker_start, marker_end, enabled_marker_start: INTEGER_32
marker_string: STRING_8
end_tag_string: STRING_8
do
from
start_index := 1
until
start_index = 0
loop
start_index := image.substring_index ("<!--##", start_index)
if start_index > 0 then
marker_start := start_index + 6
marker_end := image.substring_index ("##", marker_start)
if marker_end > marker_start then
marker_string := image.substring (marker_start, marker_end - 1)
end
check
identified_marker: marker_string /= Void and then not marker_string.is_empty
end
enabled_marker_start := image.substring_index ("<!--##" + marker_string + "##-->", start_index)
if enabled_marker_start = start_index then
replace_marker ("<!--##" + marker_string + "##-->", "")
replace_marker ("<!--/##" + marker_string + "##-->", "")
else
end_tag_string := "##/" + marker_string + "##-->"
end_index := image.substring_index (end_tag_string, start_index)
if end_index < 1 then
end_index := image.count - end_tag_string.count + 1
end
image.remove_substring (start_index, end_index + end_tag_string.count - 1)
end
end
end
end
comment_out_section (marker_string: STRING_8)
-- turns an alternative marker section of the html code on, and the default off.
-- a_number indicates which alternative section to use, starting with 1.
-- the default section labeled with number 0 is already turned on and cannot be enabled again.
require
marker_string_valid: marker_string /= Void and then not marker_string.is_empty
do
replace_marker ("<!--##" + marker_string + "##-->", "<!--##" + marker_string + "##")
replace_marker ("<!--##/" + marker_string + "##-->", "##/" + marker_string + "##-->")
end
enable_alternative_section (marker_string: STRING_8; a_number: INTEGER_32)
-- turns an alternative marker section of the html code on, and the default off.
-- a_number indicates which alternative section to use, starting with 1.
-- the default section labeled with number 0 is already turned on and cannot be enabled again.
require
marker_string_valid: marker_string /= Void and then not marker_string.is_empty
number_valid: a_number > 0
do
comment_out_section (marker_string + "_0")
enable_section (marker_string + "_" + a_number.out)
end
enable_section (marker_string: STRING_8)
-- turns an alternative marker section of the html code on, and the default off.
-- a_number indicates which alternative section to use, starting with 1.
-- the default section labeled with number 0 is already turned on and cannot be enabled again.
require
marker_string_valid: marker_string /= Void and then not marker_string.is_empty
do
replace_marker ("<!--##" + marker_string + "##-->", "")
replace_marker ("<!--##/" + marker_string + "##-->", "")
replace_marker ("<!--##" + marker_string + "##", "")
replace_marker ("##/" + marker_string + "##-->", "")
end
remove_section (marker_string: STRING_8)
-- remove the comments from the html code.
local
start_index, end_index: INTEGER_32
end_tag_string: STRING_8
do
from
start_index := 1
until
start_index = 0
loop
start_index := image.substring_index ("<!--##" + marker_string + "##", start_index)
if start_index > 0 then
end_tag_string := "##/" + marker_string + "##-->"
end_index := image.substring_index (end_tag_string, start_index)
if end_index < 1 then
end_index := image.count - end_tag_string.count + 1
end
image.remove_substring (start_index, end_index + end_tag_string.count - 1)
end
end
end
feature -- Creation
make (template: STRING_8)
require else
template_file_name_valid: template /= Void and then not template.is_empty
do
make_from_template (template)
end
feature -- Output
io: STD_FILES
-- Handle to standard file setup
-- (from ANY)
once
create Result
Result.set_output_default
ensure -- from ANY
io_not_void: Result /= Void
end
print (some: ANY)
-- Write terse external representation of `some'
-- on standard output.
-- (from ANY)
do
if some /= Void then
io.put_string (some.out)
end
end
frozen tagged_out: STRING_8
-- New string containing terse printable representation
-- of current object
-- (from ANY)
external
"built_in"
ensure -- from ANY
tagged_out_not_void: Result /= Void
end
feature -- Platform
operating_environment: OPERATING_ENVIRONMENT
-- Objects available from the operating system
-- (from ANY)
once
create Result
ensure -- from ANY
operating_environment_not_void: Result /= Void
end
feature {NONE} -- Retrieval
frozen internal_correct_mismatch
-- Called from runtime to perform a proper dynamic dispatch on `correct_mismatch'
-- from MISMATCH_CORRECTOR.
-- (from ANY)
local
l_corrector: MISMATCH_CORRECTOR
l_msg: STRING_8
l_exc: EXCEPTIONS
do
l_corrector ?= Current
if l_corrector /= Void then
l_corrector.correct_mismatch
else
create l_msg.make_from_string ("Mismatch: ")
create l_exc
l_msg.append (generating_type)
l_exc.raise_retrieval_exception (l_msg)
end
end
feature -- set content
set_content (a_content: STRING_8)
-- replace content of the current HTML page with 'a_content' string
-- (from VIEW)
do
make_empty
image.make_from_string (a_content)
end
feature --Set
replace_marker_with_file (mark_string, filename: STRING_8)
-- replace marker with the content of a text file
local
contentfile: PLAIN_TEXT_FILE
content: STRING_8
do
create contentfile.make_open_read (filename)
create content.make_empty
from
contentfile.start
until
contentfile.after
loop
contentfile.read_line
content.append (contentfile.last_string + "%N")
end
contentfile.close
replace_marker_with_string (mark_string, content)
end
replace_marker_with_string (mark_string, content: STRING_8)
-- replace marker with content
local
marker: STRING_8
do
create marker.make_from_string ("{#" + mark_string + "#}")
replace_marker (marker, content)
end
invariant
invariant_clause: True
-- from VIEW
invariant_clause: True
-- from HTML_PAGE
page_exists: out /= Void
-- from ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)
end -- class HTML_TEMPLATE_VIEW
-- Generated by ISE Eiffel --
For more details: www.eiffel.com