File: RegexReplace.xml

package info (click to toggle)
openclonk 8.1-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 169,520 kB
  • sloc: cpp: 180,479; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 145; sh: 101; javascript: 34
file content (69 lines) | stat: -rw-r--r-- 2,227 bytes parent folder | download | duplicates (5)
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
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE funcs
  SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
  <func>
    <title>RegexReplace</title>
    <category>Script</category>
    <subcat>Strings</subcat>
    <version>8.0 OC</version>
    <syntax>
      <rtype>string</rtype>
      <params>
        <param>
          <type>string</type>
          <name>text</name>
          <desc>Source string in which the replacements occur.</desc>
        </param>
        <param>
          <type>string</type>
          <name>regex</name>
          <desc>Regular expression in ECMAScript syntax</desc>
        </param>
        <param>
          <type>string</type>
          <name>replacement</name>
          <desc>New substring by which the regular expression matches will be replaced. Can reference submatches with $1, $2 etc.</desc>
        </param>
        <param>
          <type>int</type>
          <name>flags</name>
          <desc>
            Bitmask of the following values:
            <table>
              <rowh>
                <col>Constant</col>
                <col>Description</col>
              </rowh>
              <row>
                <literal_col>Regex_CaseInsensitive</literal_col>
                <col>Regular expression is case insensitive.</col>
              </row>
              <row>
                <literal_col>Regex_FirstOnly</literal_col>
                <col>Only replace the first match instead of all matches.</col>
              </row>
            </table>
          </desc>
        </param>
      </params>
    </syntax>
    <desc>
      Returns a string in which all regular expression matches are replaced by a replacement string.
    </desc>
    <examples>
      <example>
        <code><funclink>Log</funclink>(RegexReplace("hello world", "(\\w+)\\s(\\w+)", "$2 $1"));</code>
        <text>Swaps two words, displaying "world hello".</text>
      </example>
    </examples>
    <related>
      <funclink>ReplaceString</funclink>
      <funclink>RegexSearch</funclink>
      <funclink>RegexMatch</funclink>
      <funclink>RegexSplit</funclink>
    </related>
  </func>
  <author>Luchs</author><date>2016-09</date>
</funcs>