******************************************************************************
********************* IBIS GOLDEN PARSER BUG REPORT FORM *********************
******************************************************************************

INSTRUCTIONS

To report a bug in the IBIS golden parser.  Please fill out the top part
of the following form and send the complete form to ibis-info@freelists.org.

A list of reported bugs will be maintained on ibis.org.

******************************************************************************

PARSER VERSION NUMBER: 6.1.2

PLATFORM (SPARC, HP700, PC, etc.): 64-bit PC

OS AND VERSION: Microsoft Windows 10

REPORTED BY: Michael Mirmak, Intel Corporation

DATE: September 20, 2016

DESCRIPTION OF BUG:

The line number tracking of the IBISCHK6 parser appears to be incorrect when
reporting some issues. A DOS-formatted file with CR/LF characters after each
“line” below suggests that the bad close-quote character (ASCII code 9d)
shown is on line 1, when in fact it is on line 2.  The unterminated string is
also suggested as starting on line 13, several lines after the actual start of
the string in question.  This suggests that an incorrect metric is used by
IBISCHK for counting lines and matching quotation characters.  

Note that the same issue also shows up when checking a .ibs file referencing
this .ami file.

This particular file also causes three errors to be generated for a single
bad character.  Three other illegal characters are reported.  Finally, the
parser incorrectly identifies the closing parenthesis of the line in question
as being missing.

INSERT IBIS FILE DEMONSTRATING THE BUG:

(Example_Receiver
   (Description "This quotation ends in an illegal character”)
   (Reserved_Parameters
   (AMI_Version (Usage Info) (Type String) (Default "6.0")
         (Description "Valid for AMI_Version 6.0"))
   (Ignore_Bits (Usage Info) (Type Integer) (Default 20000)
         (Description "Ignore a lot of bits"))
      (Max_Init_Aggressors (Usage Info) (Type Integer) (Default 25)
         (Description "Number of aggressors is actually unlimited."))
      (Init_Returns_Impulse (Usage Info) (Type Boolean) (Default True)
         (Description "Both impulse and parameters_out returned."))
      (GetWave_Exists (Usage Info) (Type Boolean) (Default True)
         (Description "GetWave is well and truly provided in the module."))
   ) 
) 

The output displayed for “ibischk6 -numbered –ami” is:

IBISCHK6 V6.1.2
E1917 (line    1) -
    Found illegal non-7-bit ASCII character (code e2).  Converting to space.
E1917 (line    1) -
    Found illegal non-7-bit ASCII character (code 80).  Converting to space.
E1917 (line    1) -
    Found illegal non-7-bit ASCII character (code 9d).  Converting to space.
E0924 - Unterminated string detected. Possibly started at line 13
E4619 - The Parameter file bug181.ami has mismatched parenthesis

Errors  : 5

File Failed

-----------
Added Notes
-----------

If this file is changed anywhere with a text editor, three more meaningless
Error messages are displayed for line "0":

IBISCHK6 V6.1.2
E1917 (line    0) -
    Found illegal non-7-bit ASCII character (code ef).  Converting to space.
E1917 (line    0) -
    Found illegal non-7-bit ASCII character (code bb).  Converting to space.
E1917 (line    0) -
    Found illegal non-7-bit ASCII character (code bf).  Converting to space.

Just correcting the bad code 9d right quote removes the five error messages
above, but keeps or adds the three other line 0 error messages.

The best fix is to open this file into Microsoft Wordpad or Word and then
save as MS_DOS Format and then remove the .txt extension.

One possible resolution is to add the suggested fix to the illegal non-7-bit
ASCII character message.

******************************************************************************
******************** BELOW FOR ADMINISTRATION AND TRACKING *******************
******************************************************************************

BUG NUMBER:  181

SEVERITY: [FATAL, SEVERE, MODERATE, ANNOYING, ENHANCEMENT]  ANNOYING

PRIORITY: [HIGH, MEDIUM, LOW]                               MEDIUM

STATUS: [OPEN, CLOSED, WILL NOT FIX, NOT A BUG]             CLOSED

FIXED VERSION: 6.1.4

FIXED DATE:    June 28, 2017

NOTES ON BUG FIX:
Classified at the October 14, 2016 IBIS Open Forum
To be fixed in a future release.

If the problem is located, the fix should give the correct line number
and the single, illegal 8-bit ASCII character code as the E1917
message that needs to be corrected.

An option is to exit the testing after the first E1917 message to avoid
secondary, (possibiy many) misleading messages such as E0924 and E4619 and
others that would be created.

If a fix cannot be found, the "- Converting to space.", could be changed to
"- To fix, save file in MS_DOS format and remove .txt extension."

June 28, 2017
Line number corrected and testing aborted.

******************************************************************************
******************************************************************************