add EN Readme for Pire #84

AnastasiaTWW · 2020-06-15T18:35:14Z

No description provided.

sergey-v-galtsev

Thank you for the huge work you have done!

I pointed out some technical issues.

As for the translation, I did not understand several parts of the text well enough.
Could You please proofread it?
Or at least compare it to what translate.google.ru yields for the Russian readme.

sergey-v-galtsev · 2020-06-19T01:54:34Z

README.ru

@@ -120,8 +120,8 @@ LongestPrefix(), LongestSuffix(), ShortestPrefix() и ShortestSuffix(). Они
 Сканеры объединяются функцией Pire::Scanner::Glue(). В результате получается сканер,
 который за один проход проверяет строку на соответствие всем содержащимся в нём
 паттернам. Общее количество паттернов возвращает Scanner::RegexpsCount(). Вместо
-Final() имеет смысл вызвать AcceptedRegexps(const State&), возвращающая пару
-итераторов (с семантикой [begin,end)), указывающую на диапазон номеров регулярок,


It was the correct closing parenthesis ) in [begin,end) meaning the end is not inclusive. Just like in math.

sergey-v-galtsev · 2020-08-31T18:45:38Z

README.en

+is to construct it from the string with the regular expression using the Pire::Lexer class.
+
+Regular expressions have the syntax similar to POSIX. It supports standard features as
+a|b, a*, a+, ., [a-z], a{3}, a{3,5}, a{3,}) and character classes (\w (alphanumeric characters),


\w includes only alphabetical, not all alphanumerical characters. Likewise, \W is a complementary set of all not alphabetical characters.

sergey-v-galtsev · 2020-08-31T18:45:52Z

README.en

+The function Pire::Scanner::Glue() unites several machines. The resulting scanner
+checks whether the string matches all united patterns at a time. The Scanner::RegexpsCount()
+function returns common number of patterns. It is recommended to replace running Final() with
+AcceptedRegexps(const State&) that returns iterators with the [begin,end] semantics indicating the


It should be a half-open interval [begin, end) meaning the end is not inclusive.

sergey-v-galtsev · 2020-09-01T08:58:09Z

README.en

+
+Pire::Scanner CompileRegexp(const char* pattern)
+{
+	// Переводим шаблон в UCS4


There is some text left in Russian.

sergey-v-galtsev · 2020-09-01T14:26:04Z

README.en

+    * Finals(), IsFinal(), SetFinal(), ClearFinal().
+
+In addition, a bit flag field will be associated with each state and each transition of the machine.
+Transition flags are called outputs (since they implement a classic spacecraft with an output).


Please replace 'spacecraft' with 'FSM'.

AnastasiaTWW · 2020-09-08T21:31:37Z

Thank you for the huge work you have done!

I pointed out some technical issues.

As for the translation, I did not understand several parts of the text well enough.
Could You please proofread it?
Or at least compare it to what translate.google.ru yields for the Russian readme.

I'm sorry for the long replay. Thank you for the feedback! I've fixed the technical issues that you've found in the translation.

Please could you point me in translated parts that are not enough clear?

sergey-v-galtsev · 2020-09-16T23:39:22Z

README.en

+\S (non-whitespace)). Operators a&b (intersection, see Fsm::operator &), ~a (inversion, see
+Fsm::Complement), non-greedy analogs of repetitions *?, +?, ?? (Fsm::SlowCapturingScanner).
+Operators in this scanner can be set to as short expressions as possible, in contrast to greedy
+analogs that set to as long expressions as possible.


The source paragraph

Кроме того, могут быть добавлены
операции a&b (пересечение, см. Fsm::operator &) и ~a (инверсия, см. Fsm::Complement).
Помимо этого, для Fsm::SlowCapturingScanner есть возможность использовать нежадные аналоги
повторений - операторы *?, +?, ??. В этом сканере данные операторы будут принимать
как можно более короткие выражения, в отличие от жадных аналогов (которые, наоборот, принимают
как можно более длинные.

is hard for google translate.
But after tweaking both the source and its suggested translation I have got

In addition, a&b (intersection, see Fsm::operator &) and ~a (inverse, see Fsm::Complement) can be used.
Also, Fsm :: SlowCapturingScanner has the ability to use non-greedy repetition operators - * ?, + ?, ??.
These operators will accept as short subtexts as possible, as opposed to greedy counterparts (which, on the contrary, accept as long as possible).

Our FSMs are acceptors. So the words "to accept" and "to match" can be used interchangeably. Whilst the word "to set" is not suitable here.

sergey-v-galtsev · 2020-09-16T23:43:00Z

README.en

+United machines can be united once again. However, it is not recommended to repeat union
+indefinitely because the number of states in the resulting scanner grows
+exponentially with each added pattern. The max size of the scanners can be specified in
+the maxSize parameter in the function Glue(). If the specified size is exceeded, an empty scanner
+will be returned (Size() == 0, Empty() == true).


For the source paragraph

Склеенные сканеры в свою очередь можно склеить между собой. В то же время процесс склейки
нельзя повторять до бесконечности, потому как количество состояний в полученном автомате
растёт экспоненциально с каждым добавленным паттерном. Иногда имеет смысл ограничить
размер полученного автомата, указав ненулевой параметр maxSize в Glue(). В таком случае
при превышении указанного размера возвращается пустой автомат (Size() == 0, Empty() == true).

https://translate.google.ru suggests

The glued scanners, in turn, can be glued together. At the same time, the gluing process
cannot be repeated indefinitely, because the number of states in the resulting machine
grows exponentially with each added pattern. Sometimes it makes sense to limit
the size of the resulting automaton by specifying a nonzero maxSize parameter in Glue (). In this case
when the specified size is exceeded, an empty automaton is returned (Size () == 0, Empty () == true).

Which seams a bit clearer to me. First of all, it uses the words "to glue" and "the scanner" which are used for the same purpose in the code itself. This makes it easier to understand the code by reading the documentation.

I would suggest using "to glue" and "glued" instead of "to unite" and "united" in the previous paragraphs as well. Even if there seems to be a lot of tautologies this way, it is better for technical documentation.

sergey-v-galtsev · 2020-09-17T16:39:44Z

README.en

+
+Each scanner has the State type that stores the state, and methods Initialize(State&)
+to return the initial machine state, Next(State&, char) to take the machine to the next state,
+Final(const State&) to report whether the state is valid. To check whether the string matches


It is better to use the word 'final' instead of 'valid':

Final(const State&) to report whether the state is final (ie. the processed text is accepted by the machine).

sergey-v-galtsev · 2020-09-17T16:43:15Z

README.en

+Numbers start from 0 and, after union, numbers of expressions on the right are shifted
+by the expression numbers on the left.


Numbers start from 0 and, after the Pire::Scanner::Glue() function, numbers of patterns on the right are shifted by the pattern count on the left.

sergey-v-galtsev · 2020-09-17T16:48:43Z

README.en

+
+    * i - case insensitive
+    * u - compile the expression in UTF-8
+    * s - escape the expression .* on each side


s - surround the pattern by .* on each side

sergey-v-galtsev · 2020-09-17T16:52:57Z

README.en

+The following characters can be in the string with flags:
+
+    * i - case insensitive
+    * u - compile the expression in UTF-8


The terms "regular expression" and "pattern" can be used interchangeably, but I would not use just "expression" because it is a broader term.

sergey-v-galtsev · 2020-09-17T16:56:12Z

README.en

+In the inherited class, the following methods should be overridden:
+
+    * wchar32 FromLocal(const char*& begin, const char* end) reads and returns input character and forwards begin.
+      Returns an exceprion if the input includes an invalid sequence.


Please, replace "exceprion" with "exception".

And it is more common to say "to throw an exception" than "to return an exception".

sergey-v-galtsev · 2020-09-17T16:56:58Z

README.en

+    * Default constructor: creates the scanner that allows an empty string
+    * MakeFalse(): creates the scanner that does not allows any string
+    * Size(): the scanner size (number of states)
+    * Append(unsigned char c): adds to the machine the transition for the match with .


Append(unsigned char c): adds to the machine the transition matching the given character.

sergey-v-galtsev · 2020-09-17T16:58:52Z

README.en

+    * MakeFalse(): creates the scanner that does not allows any string
+    * Size(): the scanner size (number of states)
+    * Append(unsigned char c): adds to the machine the transition for the match with .
+    * AppendStrings(const vector<string>&): adds to the machine the transition for


AppendStrings(const vector&): adds transitions to the machine that match any of the given strings

sergey-v-galtsev · 2020-09-17T17:01:47Z

README.en

+cycle writing it as a single expression (see an example).
+
+Four more functions helpful in lexical analysis are LongestPrefix(), LongestSuffix(), ShortestPrefix(),
+and ShortestSuffix(). These functions returns the largest / the smallest prefix or suffix allowed by


It is better to say that the FSM "matches" or "accepts" the given text, rather than "allows". Please, check other uses of the word "to allow" in the same context.

sergey-v-galtsev · 2020-09-17T17:05:09Z

README.en

+    * i - case insensitive
+    * u - compile the expression in UTF-8
+    * s - escape the expression .* on each side
+    * a - enable checking for the & and ~ operators in expressions (see above)


a - enable support for the & and ~ operators in expressions (see above)

sergey-v-galtsev · 2020-09-17T17:06:10Z

README.en

+should be performed.
+
+The serialized scanner is not portable between architectures (even between x86 and x86_64).
+When trying to read or map the regular expression serialized in another architecture,


serialized on another architecture

sergey-v-galtsev · 2020-09-17T17:08:36Z

README.en

+      Returns an exceprion if the input includes an invalid sequence.
+    * std::string ToLocal(wchar32) returns returns the byte representation of the character in this encoding.
+      If the character in this encoding is not representable, returns an empty string.
+    * AppendDot(Fsm&) adds a fragment to the end machine that allows any one character in this encoding.


AppendDot(Fsm&) appends to the end of the machine a fragment that accepts any character in this encoding.

sergey-v-galtsev · 2020-09-17T17:09:04Z

README.en

+
+    * wchar32 FromLocal(const char*& begin, const char* end) reads and returns input character and forwards begin.
+      Returns an exceprion if the input includes an invalid sequence.
+    * std::string ToLocal(wchar32) returns returns the byte representation of the character in this encoding.


returns returns -> returns

sergey-v-galtsev · 2020-09-17T17:09:52Z

README.en

+cycle writing it as a single expression (see an example).
+
+Four more functions helpful in lexical analysis are LongestPrefix(), LongestSuffix(), ShortestPrefix(),
+and ShortestSuffix(). These functions returns the largest / the smallest prefix or suffix allowed by


These functions returns -> These functions return

sergey-v-galtsev · 2020-09-17T20:48:43Z

As an example, I suggested replacements for a couple of paragraphs.
And highlighted some other issues of the translation that caught my eye.
Could You please proofread the rest of the text?
Thank You in advance!

add EN Readme

91bdb4e

sergey-v-galtsev requested changes Sep 1, 2020

View reviewed changes

fix bugs in translation

80ac847

sergey-v-galtsev reviewed Sep 16, 2020

View reviewed changes

sergey-v-galtsev reviewed Sep 17, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add EN Readme for Pire #84

add EN Readme for Pire #84

AnastasiaTWW commented Jun 15, 2020

sergey-v-galtsev left a comment

sergey-v-galtsev Jun 19, 2020

sergey-v-galtsev Aug 31, 2020

sergey-v-galtsev Aug 31, 2020

sergey-v-galtsev Sep 1, 2020

sergey-v-galtsev Sep 1, 2020

AnastasiaTWW commented Sep 8, 2020

sergey-v-galtsev Sep 16, 2020 •

edited

Loading

sergey-v-galtsev Sep 16, 2020 •

edited

Loading

sergey-v-galtsev Sep 17, 2020

sergey-v-galtsev Sep 17, 2020 •

edited

Loading

sergey-v-galtsev Sep 17, 2020

sergey-v-galtsev Sep 17, 2020 •

edited

Loading

sergey-v-galtsev Sep 17, 2020

sergey-v-galtsev Sep 17, 2020 •

edited

Loading

sergey-v-galtsev Sep 17, 2020

sergey-v-galtsev Sep 17, 2020 •

edited

Loading

sergey-v-galtsev Sep 17, 2020

sergey-v-galtsev Sep 17, 2020

sergey-v-galtsev Sep 17, 2020

sergey-v-galtsev Sep 17, 2020

sergey-v-galtsev Sep 17, 2020

sergey-v-galtsev commented Sep 17, 2020

		Numbers start from 0 and, after union, numbers of expressions on the right are shifted
		by the expression numbers on the left.

add EN Readme for Pire #84

Are you sure you want to change the base?

add EN Readme for Pire #84

Conversation

AnastasiaTWW commented Jun 15, 2020

sergey-v-galtsev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AnastasiaTWW commented Sep 8, 2020

sergey-v-galtsev Sep 16, 2020 • edited Loading

Choose a reason for hiding this comment

sergey-v-galtsev Sep 16, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sergey-v-galtsev Sep 17, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sergey-v-galtsev Sep 17, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sergey-v-galtsev Sep 17, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sergey-v-galtsev Sep 17, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sergey-v-galtsev commented Sep 17, 2020

sergey-v-galtsev Sep 16, 2020 •

edited

Loading

sergey-v-galtsev Sep 16, 2020 •

edited

Loading

sergey-v-galtsev Sep 17, 2020 •

edited

Loading

sergey-v-galtsev Sep 17, 2020 •

edited

Loading

sergey-v-galtsev Sep 17, 2020 •

edited

Loading

sergey-v-galtsev Sep 17, 2020 •

edited

Loading