Actual initial commit.

.github/workflows/unit_test.yml

@@ -0,0 +1,42 @@
+name: unit_test
+on:
+  push:
+    paths:
+      - '**.cpp'
+      - '**.h'
+      - 'test/*'
+      - 'meson.build'
+      - '.github/workflows/*'
+  pull_request:
+    paths:
+      - '**.cpp'
+      - '**.h'
+      - 'test/*'
+      - 'meson.build'
+      - '.github/workflows/*'
+
+jobs:
+  unit_test:
+    permissions:
+      contents: read
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: [11, 20]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install meson
+        run: sudo apt-get install meson
+
+      - name: Setup
+        run: meson setup build -Dcpp_std=c++${{ matrix.version }}
+
+      - name: Compile
+        working-directory: build
+        run: meson compile
+
+      - name: Run Test
+        working-directory: build
+        run: meson test

CC0-1.0.legalcode.txt

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

Readme.md

@@ -0,0 +1,141 @@
+# TPhrase, Translatable phrase generator for C++11
+
+This library is one of the translatable phrase generators. See [the manual](manual.md) for details.
+
+[Lua version is here.](https://github.com/oo13/translatable_phrase_generator)
+
+## What's the translatable phrase generator
+
+1. The generator can generate a phrase (like a word, a name, a sentence, and a paragraph) with a syntax rule expressed by a text that can be replaced (=translated) in the run-time.
+1. The syntax rule can express the phrase in many languages other than English.
+
+For instance, [Context-free grammar of Wesnoth](https://wiki.wesnoth.org/Context-free_grammar) is a translatable phrase generator. [The phrase node in Endless Sky](https://github.com/endless-sky/endless-sky/wiki/CreatingPhrases) might be, except that it cannot replace the text of the syntax rule.
+
+## Motive for Creating Another One
+[Context-free grammar of Wesnoth](https://wiki.wesnoth.org/Context-free_grammar) can theoretically describe a phrase syntax rule in many languages, but a syntax rule that can be simply expressed a combination of words in English might not be expressed by a combination in other languages because they have inflection and so on; a syntax rule with three production rules have ten options in English may be translated into a syntax rule with one production rule have a thousand options in a language. It's hard to maintain a "combination explosion" like this. (In other hand, the expandable to all options in a single production rule means translatable. If a method doesn't allow the translator to specify all options, it may be impossible to translate potentially.)
+
+Also a word in English cannot always translate into the same word of a language in the different sentence, and it should be translated a various word depended on the context. It causes a trouble similar to inflection.
+
+As far as I had experienced about translating the phrase node in my translatable version of Endless Sky, the substitution is effective to handle the inflection and the like depended on the context, and the sophisticated substitution may make easy to handle the changing word order.
+
+[Context-free grammar of Wesnoth](https://wiki.wesnoth.org/Context-free_grammar)  has no substituting functions. That's why I would create another phrase generator that wasn't compatible with it.
+
+## Features (in comparison with Context-free grammar of Wesnoth)
+- gsub (global substitution) function.
+- Generator with a parameter to restrict the context.
+- Equal chance to generate all possible texts by default, and the creator can change it.
+- The comment blocks to maintain the translation easily.
+- Don't care some white spaces for readability.
+
+## Example of Phrase Syntax
+Japanese translation of Arach ship's name in Endless Sky (excerpt):
+```
+ARACH_START= マg | グラb | ブロg | ブロp | ブラb | モg | モb {* | ... }
+ARACH_MIDDLE = aラg | aバg | グラg | グロp | aロp | プルーt {* | ... }
+ARACH_NEXT = ・{ARACH_START}
+ARACH_EMPTY = ""
+main = {ARACH_START}{ARACH_MIDDLE}{=
+         {ARACH_MIDDLE} | {ARACH_EMPTY} | {ARACH_NEXT}
+       }{=
+         {ARACH_MIDDLE} | {ARACH_EMPTY}
+       } ~
+       /ga/ガ/g ~
+       /ba/バ/g ~
+       /pa/パ/g ~
+       /ta/タ/g ~
+       /g/グ/g ~
+       /b/ブ/g ~
+       /p/プ/g ~
+       /t/トゥ/g
+```
+Gsubs handle the characters that must be replaced by the combination with preceding and succeeding words.
+
+Inflection:
+```
+ARTICLES = a | the | that | its
+NOUNS = @apple | banana | @orange | @avocado | watermelon
+main = {ARTICLES} {NOUNS} ~
+       /a @/an / ~
+       /@//
+```
+
+An example that an English word cannot translates into the same word in Japanese.
+English version:
+```
+ECONOMICAL_SITUATION = poor | rich
+main = You are {ECONOMICAL_SITUATION}. |
+       You purchased a {ECONOMICAL_SITUATION} ship.
+```
+
+Japanese version:
+```
+ECONOMICAL_SITUATION = 貧乏 | 裕福
+main = あなたは{ECONOMICAL_SITUATION}です。 |
+       あなたは{ECONOMICAL_SITUATION}な船を購入しました。 ~
+       /貧乏な船/粗末な船/ ~
+       /裕福な船/豪華な船/
+```
+If you use a simple substitution instead of a translatable phrase generator, it cannot translate. For example:
+```
+   if (rand() > 0.5) {
+      word = _("poor");
+   } else {
+      word = _("rich");
+   }
+   if (rand() > 0.5) {
+      message = format(_("You are %s."), word);
+   } else {
+      message = format(_("You purchased a %s ship."), word);
+   }
+```
+The translator can create only two independent messages at most but Japanese translator need four independent messages.
+# To Build the Library
+Use meson.
+```
+% meson setup build
+% cd build
+% meson compile
+```
+
+I tested on meson 1.4.1.
+
+# To Generate C++ Library Manual
+Use doxygen.
+
+Library User's Manual:
+```
+% doxygen tphrase.doxygen
+```
+
+Library Developer's Manual:
+```
+% doxygen tphrase_internal.doxygen
+```
+
+I tested on doxygen 1.9.8.
+
+# Unit Test
+Use meson.
+
+```
+% meson setup build
+% cd build
+% meson test
+```
+
+I tested on meson 1.4.1.
+
+# Requirement
+
+TPhrase supports C++11 or later, and it's tested on C++11 and C++20.
+
+# License
+This file is part of TPhrase.
+
+TPhrase 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, either version 3 of the License, or (at your option) any later version.
+
+TPhrase 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 TPhrase.  If not, see <http://www.gnu.org/licenses/>.
+
+Copyright © 2024 OOTA, Masato

copyright

@@ -0,0 +1,38 @@
+Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: tphrase
+Upstream-Contact: ooyooxei+gh@gmail.com
+Source: https://github.com/oo13/tphrase
+
+Files: *
+Copyright: © 2024 OOTA, Masato
+License: GPL-3.0-or-later
+
+Files:
+ meson.build
+ test/meson.build
+ tphrase.doxygen
+ tphrase_internal.doxygen
+Copyright: © 2024 OOTA, Masato
+License: CC0-1.0
+
+License: GPL-3.0-or-later
+ This program 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, either version 3 of the License, or
+ (at your option) any later version.
+ .
+ This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+
+License: CC0-1.0
+ To the extent possible under law, the author(s) have dedicated all copyright
+ and related and neighboring rights to this software to the public domain
+ worldwide. This software is distributed without any warranty.
+ .
+ You should have received a copy of the CC0 1.0 Universal along with
+ this software. If not, see <https://creativecommons.org/publicdomain/zero/1.0/legalcode>.