[Uim-bugs] [Bug 1420] New: doc/HELPER-PROTOCOL should be rewritten in familiar BNF style

[bugzilla-daemon at freedesktop.org]

Please do not reply to this email: if you want to comment on the bug, go to          
the URL shown below and enter yourcomments there.   
 
https://freedesktop.org/bugzilla/show_bug.cgi?id=1420        
   
           Summary: doc/HELPER-PROTOCOL should be rewritten in familiar BNF
                    style
           Product: UIM
           Version: unspecified
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: enhancement
          Priority: P3
         Component: doc
        AssignedTo: mover at hct.zaq.ne.jp
        ReportedBy: yamaken at bp.iij4u.or.jp
                CC: uim-bugs at freedesktop.org


doc/HELPER-PROTOCOL contains useful information as below, but the protocol
definition language used in is not familiar for ordinary programmers.

Message format:
  "$command\n$messages\n\n"
   $command: [ focus_in            |
               focus_out           |
               prop_activate       |
               ...]
* $command = "prop_activate"
  format:
    "prop_activate\n$str\n"

Using well-known BNF style definition will reduce learning cost and help
communication. Although BNF is used with various dialects (such as "=" and
"::="), core concept is stable and easy to understand.

Above example can be rewritten as follows (warning: the defined protocol itself
may not be accurate). See RFCs such as RFC2616 for example.

session = messages "\n\n"
messages = message | messages message
message = focus_in | focus_out | prop_activate | ... 
focus_in = "focus_in\n"
focus_out = "focus_out\n"
prop_activate = "prop_activate\n" str "\n"
str = ...

Although the task is initially assigned to Kazuki, I could do the rewriting or
any cooperation.        
   
   
--         
Configure bugmail: https://freedesktop.org/bugzilla/userprefs.cgi?tab=email       
   
------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.