summaryrefslogtreecommitdiffabout
path: root/include/sitecing/util.h
Unidiff
Diffstat (limited to 'include/sitecing/util.h') (more/less context) (show whitespace changes)
-rw-r--r--include/sitecing/util.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/sitecing/util.h b/include/sitecing/util.h
index 5750ab6..a38ae90 100644
--- a/include/sitecing/util.h
+++ b/include/sitecing/util.h
@@ -1,57 +1,57 @@
1#ifndef __SITECING_UTIL_H 1#ifndef __SITECING_UTIL_H
2#define __SITECING_UTIL_H 2#define __SITECING_UTIL_H
3 3
4#include <ostream> 4#include <ostream>
5#include <string> 5#include <string>
6#include "sitecing/acomponent.h" 6#include "sitecing/acomponent.h"
7 7
8/** 8/**
9 * @file 9 * @file
10 * @brief more or less non-internal utility classes and functions. 10 * @brief more or less non-internal utility classes and functions.
11 */ 11 */
12 12
13namespace sitecing { 13namespace sitecing {
14 using namespace std; 14 using namespace std;
15 15
16 /** 16 /**
17 * the html_escape options enumeration. 17 * the html_escape options enumeration.
18 */ 18 */
19 enum html_escape_options { 19 enum html_escape_options {
20 /** 20 /**
21 * Turn spaces into &nbsp; 21 * Turn spaces into &nbsp;
22 */ 22 */
23 html_escape_nbsp = 0x0001, 23 html_escape_nbsp = 0x0001,
24 /** 24 /**
25 * Turn newlines into <br/> or <br>. 25 * Turn newlines into br/ or br.
26 */ 26 */
27 html_escape_br = 0x0002, 27 html_escape_br = 0x0002,
28 /** 28 /**
29 * Turn quotes to &quot; 29 * Turn quotes to &quot;
30 */ 30 */
31 html_escape_quot = 0x0004, 31 html_escape_quot = 0x0004,
32 /** 32 /**
33 * Do not put '/' into <br/> consruct. 33 * Do not put '/' into br consruct.
34 */ 34 */
35 html_escape_br_noslash = 0x0008 35 html_escape_br_noslash = 0x0008
36 }; 36 };
37 /** 37 /**
38 * Escape string suitable for html output. 38 * Escape string suitable for html output.
39 * @param str the string. 39 * @param str the string.
40 * @param flags options. 40 * @param flags options.
41 * @return the string escaped. 41 * @return the string escaped.
42 * @see html_escape_options 42 * @see html_escape_options
43 */ 43 */
44 string html_escape(const string& str,int flags=html_escape_br); 44 string html_escape(const string& str,int flags=html_escape_br);
45 45
46 /** 46 /**
47 * The output string checkpoint object, letting one to rollback output. 47 * The output string checkpoint object, letting one to rollback output.
48 */ 48 */
49 class checkpoint { 49 class checkpoint {
50 public: 50 public:
51 /** 51 /**
52 * The object's death will enumeration. 52 * The object's death will enumeration.
53 */ 53 */
54 enum will_t { 54 enum will_t {
55 /** 55 /**
56 * The stream is to be rolled back at object destruction. 56 * The stream is to be rolled back at object destruction.
57 */ 57 */