FWD » Core Development » Base Language

This task is created to cover the implementation details of SESSION:STREAM.

In method_attributes.rules:

               <!-- SESSION -->
               <rule>methodText.length() == 0 and
                     (htype == prog.kw_session or ref.type == prog.var_handle)

                  <rule> ftype == prog.kw_stream
                     <action>methodText = "SessionUtils.stream"</action>
                  </rule>
               ...

In SessionUtils:

    /**
    * Returns a value that specifies the character set used for operating system file I/O — "ibm850" or
    * "iso8859-1".
    *
    * @return   See above.
    */
   public static character stream()
   {
      String streamCP = I18nOps.convmap2JavaDefault
                               .get(I18nOps._getCPInternal()).equals("IBM850")  ? "IBM850" : "ISO8859-1";
      return new character(streamCP);
   }

I'm not sure if this can be considered a solution yet. I'll need to look further to make sure that SESSION:STREAM does indeed only return "IBM850" or "ISO8859-1".

I tested the OE application and introduced other encoding formats in startup. SESSION:STREAM can also output other encodings such as UTF-8.

    /**
    * Returns a value that specifies the character set used for operating system file I/O, such as"ibm850" or
    * "iso8859-1".
    *
    * @return   See above.
    */
   public static character stream()
   {
      String streamCP = I18nOps.convmap2JavaDefault.get(I18nOps._getCPInternal());
      return new character(streamCP);
   }

Committed 9411a revision 15609.

Code Review Task Branch 9411a Revision 15609

1. Instead of SessionUtils, the getter should be in I18nOps.

2. The code should probably be reporting the same value as getCPStream() (SESSION:CPSTREAM) instead of _getCPInternal() (SESSION:CPINTERNAL). In other words, in OE does the SESSION:STREAM return value match the same value as SESSION:CPSTREAM or SESSION:CPINTERNAL? Please check. You will have to set the two values differently on the command line when starting the session.

3. The getter needs to be added to CommonSession with the proper annotations.

Committed 9411a revision 15610.

Since we moved the stream() method we should also do the following changes:

=== modified file 'src/com/goldencode/p2j/util/I18nOps.java'
--- old/src/com/goldencode/p2j/util/I18nOps.java    2024-12-10 09:06:10 +0000
+++ new/src/com/goldencode/p2j/util/I18nOps.java    2024-12-10 09:21:53 +0000
@@ -1003,7 +1003,7 @@
     */
    public static character stream()
    {
-      return new character(I18nOps.convmap2JavaDefault.get(I18nOps.getCPStream().value));
+      return new character(convmap2JavaDefault.get(getCPStream().value));
    }

    /**

Committed 9411a revision 15611.

Review of 9411a:

• please keep the naming consistent with the rest of CommonSession API (aka use get prefix)
• honor the 110 characters per line limitation.
• the javadoc of CommonSession.stream is wrong
• use _getCPStream instead of getCPStream to retrieve the actual String instead of character.
• the javadoc of I18nOps.stream can be improved
  • there can be other streams return apparently, beside ibm850 and iso8859-1, right?
  • please rephrase and use an appropriate return description.
• keep spacing consistent in: <rule> ftype == prog.kw_stream (remove leading space).

Functional: I might not properly understand the use of convmap2JavaDefault. What is the goal of converting to the Java CP equivalent to provide legacy support of STREAM?

Alexandru Lungu wrote:

Functional: I might not properly understand the use of convmap2JavaDefault. What is the goal of converting to the Java CP equivalent to provide legacy support of STREAM?

This is not something that I can test on OE, but if we look at convmap2JavaDefault.put("1256", "windows-1256"); isn't the actual encoder "windows-1256" and not "1256"? Looking at convmap2JavaDefault I see that some keys look like they are shorter versions of the value they hold.

If convmap2JavaDefault is not needed then we can either change the rules to call getCPStream directly:

                   <rule> ftype == prog.kw_stream
                     <action>methodText = "I18nOps.getCPStream"</action>
                   </rule>

Or modify getStream as such:

   public static character getStream()
   {
      return getCPStream();
   }

Eugenie: Please review and comment on #9411-14.

is not needed then we can either change the rules to call getCPStream directly

Does STREAM always report the same value as CPSTREAM in OE? If so, then you are right that we should consider just making STREAM a synonym for CPSTREAM instead of a separate getter. In other words, we could make STREAM convert to I18NOps.getCPStream() at conversion.

• the encoder is the key of convmap2JavaDefault
• SESSION:STREAM and SESSION:CPSTREAM always had the same value.

As such I think we can go ahead and make SESSION:STREAM be SESSION:CPSTREAM at conversion.

As such I think we can go ahead and make SESSION:STREAM be SESSION:CPSTREAM in conversion.

Running a 4GL application with -cpstream option at CLI is also changing STREAM? Also, using -stream option at CLI, does the CPSTREAM change?
Also, what happens if you specific an invalid -cpstream / -stream at CLI? Are their respective attribute unknown? Maybe they are different from the POV of error handling.

Perfect. OE treats these as synonyms too. Go ahead with that idea.

Committed 9411a revision 15609.

=== modified file 'rules/convert/methods_attributes.rules'
--- old/rules/convert/methods_attributes.rules    2024-07-01 08:01:37 +0000
+++ new/rules/convert/methods_attributes.rules    2024-12-10 14:18:50 +0000
@@ -566,6 +566,7 @@
 ** 235 GBB 20240515          Added conversion for SESSION:GET-LOGIN-PARAMETER.
 ** 236 GBB 20240610          Move getClientType from LogicalTerminal to SessionUtils.
 ** 237 HC  20240630          Implemented support for WEB-FILE-UPLOAD statement.
+** 238 EM  20241210          Implemented support for SESSION:STREAM.
 */
  -->

@@ -2610,7 +2611,7 @@
                      <action>methodText = "I18nOps.getCPRCodeOut"</action>
                   </rule>

-                  <rule>ftype == prog.kw_cpstream
+                  <rule>ftype == prog.kw_cpstream or ftype == prog.kw_stream
                      <action>methodText = "I18nOps.getCPStream"</action>
                   </rule>

Please apply the changes to the branch.

It is already committed!

Greg Shah wrote:

Eugenie: Please review and comment on #9411-14.

is not needed then we can either change the rules to call getCPStream directly

Does STREAM always report the same value as CPSTREAM in OE? If so, then you are right that we should consider just making STREAM a synonym for CPSTREAM instead of a separate getter. In other words, we could make STREAM convert to I18NOps.getCPStream() at conversion.

I agree, we can consider STREAM and CPSTREAM as synonyms, making same call in converted code.

For convmap2JavaDefault purpose. This is a map to make make relationship between encoding name used in 4GL and relative name used in Java. Because sometimes the names can be different for the same encoding to use. That's my understanding for the map usage (initially designed for).

Please update the gap marking for this attribute (mark it full/partial the same way that cpstream is marked).

Then let's get this merged.

Committed 9411a revision 15610.