-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathTextileConverterBase_8cs_source.html
More file actions
163 lines (161 loc) · 15 KB
/
TextileConverterBase_8cs_source.html
File metadata and controls
163 lines (161 loc) · 15 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>RoboClerk: RoboClerk.Redmine/TextileConverterBase.cs Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">RoboClerk<span id="projectnumber"> 1.1</span>
</div>
<div id="projectbrief">A documentation as code system</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('TextileConverterBase_8cs_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">TextileConverterBase.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="TextileConverterBase_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="keyword">using </span>System;</div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="keyword">using </span>System.Collections.Generic;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>System.Text.RegularExpressions;</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceRoboClerk_1_1Redmine.html">RoboClerk.Redmine</a></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span>{</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="classRoboClerk_1_1Redmine_1_1TextileConverterBase.html"> 10</a></span> <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">class </span><a class="code hl_class" href="classRoboClerk_1_1Redmine_1_1TextileConverterBase.html">TextileConverterBase</a> : ITextileConverter</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classRoboClerk_1_1Redmine_1_1TextileConverterBase.html#ade6bb1e96c19a61e7a099518edbd4f8a"> 17</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span> <a class="code hl_function" href="classRoboClerk_1_1Redmine_1_1TextileConverterBase.html#ade6bb1e96c19a61e7a099518edbd4f8a">Convert</a>(<span class="keywordtype">string</span> textile)</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> {</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keywordflow">if</span> (textile == <span class="keyword">null</span>)</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(textile));</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// Store RoboClerk tags with unique placeholders to protect them from conversion</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> Dictionary<string, string> roboClerkTagContents = <span class="keyword">new</span> Dictionary<string, string>();</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordtype">int</span> roboClerkTagIndex = 0;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// Extract and replace RoboClerk tags with placeholders</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// Match both inline tags (@@tag@@) and block tags (@@@block@@@)</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// Block tags can span multiple lines, so we need to use non-greedy matching</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> textile = Regex.Replace(textile, <span class="stringliteral">@"@@@(.*?)@@@"</span>, m =></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> {</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordtype">string</span> content = m.Groups[1].Value;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">string</span> placeholder = $<span class="stringliteral">"ROBOCLERKBLOCKPLACEHOLDER{roboClerkTagIndex}"</span>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> roboClerkTagContents[placeholder] = m.Value; <span class="comment">// Store the complete tag including @@@</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> roboClerkTagIndex++;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordflow">return</span> placeholder;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> }, RegexOptions.Singleline);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> textile = Regex.Replace(textile, <span class="stringliteral">@"@@([^@]+)@@"</span>, m =></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> {</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">string</span> content = m.Groups[1].Value;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">string</span> placeholder = $<span class="stringliteral">"ROBOCLERKINLINEPLACEHOLDER{roboClerkTagIndex}"</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> roboClerkTagContents[placeholder] = m.Value; <span class="comment">// Store the complete tag including @@</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> roboClerkTagIndex++;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordflow">return</span> placeholder;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> }, RegexOptions.Singleline);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// Perform the actual conversion using the derived class implementation</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">string</span> convertedText = <a class="code hl_function" href="classRoboClerk_1_1Redmine_1_1TextileConverterBase.html#a8fc69fa01cf375ca4d003c6cd83d8fdc">ConvertTextile</a>(textile);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// Restore RoboClerk tags</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordflow">foreach</span> (var placeholder <span class="keywordflow">in</span> roboClerkTagContents.Keys)</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> {</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> convertedText = convertedText.Replace(placeholder, roboClerkTagContents[placeholder]);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> }</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordflow">return</span> convertedText;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> }</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="classRoboClerk_1_1Redmine_1_1TextileConverterBase.html#a8fc69fa01cf375ca4d003c6cd83d8fdc"> 64</a></span> <span class="keyword">protected</span> <span class="keyword">abstract</span> <span class="keywordtype">string</span> <a class="code hl_function" href="classRoboClerk_1_1Redmine_1_1TextileConverterBase.html#a8fc69fa01cf375ca4d003c6cd83d8fdc">ConvertTextile</a>(<span class="keywordtype">string</span> textile);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> }</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>} </div>
<div class="ttc" id="aclassRoboClerk_1_1Redmine_1_1TextileConverterBase_html"><div class="ttname"><a href="classRoboClerk_1_1Redmine_1_1TextileConverterBase.html">RoboClerk.Redmine.TextileConverterBase</a></div><div class="ttdoc">Base class for Textile converters that provides RoboClerk tag protection functionality.</div><div class="ttdef"><b>Definition:</b> <a href="TextileConverterBase_8cs_source.html#l00010">TextileConverterBase.cs:11</a></div></div>
<div class="ttc" id="aclassRoboClerk_1_1Redmine_1_1TextileConverterBase_html_a8fc69fa01cf375ca4d003c6cd83d8fdc"><div class="ttname"><a href="classRoboClerk_1_1Redmine_1_1TextileConverterBase.html#a8fc69fa01cf375ca4d003c6cd83d8fdc">RoboClerk.Redmine.TextileConverterBase.ConvertTextile</a></div><div class="ttdeci">abstract string ConvertTextile(string textile)</div><div class="ttdoc">Performs the actual Textile conversion. This method must be implemented by derived classes.</div></div>
<div class="ttc" id="aclassRoboClerk_1_1Redmine_1_1TextileConverterBase_html_ade6bb1e96c19a61e7a099518edbd4f8a"><div class="ttname"><a href="classRoboClerk_1_1Redmine_1_1TextileConverterBase.html#ade6bb1e96c19a61e7a099518edbd4f8a">RoboClerk.Redmine.TextileConverterBase.Convert</a></div><div class="ttdeci">string Convert(string textile)</div><div class="ttdoc">Converts Textile content while protecting RoboClerk tags from being processed.</div><div class="ttdef"><b>Definition:</b> <a href="TextileConverterBase_8cs_source.html#l00017">TextileConverterBase.cs:17</a></div></div>
<div class="ttc" id="anamespaceRoboClerk_1_1Redmine_html"><div class="ttname"><a href="namespaceRoboClerk_1_1Redmine.html">RoboClerk.Redmine</a></div><div class="ttdef"><b>Definition:</b> <a href="CustomFieldsJSONObjects_8cs_source.html#l00005">CustomFieldsJSONObjects.cs:6</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_6f702c045b6b2a55f2b9c955f7b8688b.html">RoboClerk.Redmine</a></li><li class="navelem"><a class="el" href="TextileConverterBase_8cs.html">TextileConverterBase.cs</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
</ul>
</div>
</body>
</html>