LCS_2016_015_History < P1076

P1076 Web>VHDL2017>LCS2016_015>LCS_2016_015_History (2017-04-24, JimLewis) (raw view)EditAttach
---+ Language Change Specification for Report Calling Path

---++ 

| <sticky><b>LCS Number:</b></sticky> | LCS-2016-015 |
| <sticky><b>Version:</b>   </sticky> | 6 |
| <sticky><b>Date:</b>      </sticky> | 20-Mar-2017 |
| <sticky><b>Status:</b>    </sticky> | Voting |
| <sticky><b>Author:</b>    </sticky> | Jim Lewis |
| <sticky><b>Email:</b>     </sticky> | [[Main.JimLewis]] and [[Main.PatrickLehmann]] |
 | <sticky><b>Source Doc:</b></sticky> | [[LCS_2016_015_calling_path][LCS]] [[LCS_2016_015_Examples][Examples]] [[ReportCallingPath][Report Calling Path]] |
| <sticky><b>Summary:</b>   </sticky> | CALL_..._NAME = Call stack with SIMPLE_NAME, PATH_NAME, INSTANCE_NAME |

---+++ Voting Results: Cast your votes here

Yes:

   1 %USERSIG{JimLewis - 20-Mar-2017}% ver 6
   1 %USERSIG{MarkZwolinski - 2017-03-07}% ver 3
   1 %USERSIG{RobGaddi - 2017-03-19}% ver 5
   1 %USERSIG{Lieven Lemiengre - 2017-03-20}% ver 5 - it's ok in it's current form but I would like to see Patrick Lehmann proposed changes applied
   1 %USERSIG{PatrickLehmann - 2017-03-20}% ver 6
   1 %USERSIG{LarsAsplund - 2017-03-23}% ver 6 - Some typos need fixing but otherwise it's ok

No:
   1 

Abstain:
   1 %USERSIG{MartinZabel - 2017-02-15}% any version - tool should be enhanced instead.
   1 %USERSIG{MartinThompson- 2017-02-17}% Ditto

---++ Revision Notes

Revision 7: 24-Mar-2017
  * Added text about GET_CALL_PATH return value " The value designated by the return value has an ascending index range and a left-most index that is 0"

Revision 6: 20-Mar-2017
  * Updated naming of the types to mostly match Patrick's request.  
  * only CALL_PATH_VECTOR_PTR is different.

Revision 5: 18-Mar-2017
  * Per meeting 16-Mar-2017, changed to function in std.env

Revision 4:  10-Mar-2017
   * Updated and reconciled with 015a.

revision 3:  19-Feb-2017
   * Selected array version as the one to go forward with

revision 2  15-Feb-2017
   * Updated contents of record to current file and line.

revision 1  Original  14-Feb-2017

---++ Style Notes

<noautolink>
<sticky>
Changes are shown in %RED%red font%ENDCOLOR%.  
Deletions are %RED%<del>crossed out</del>%ENDCOLOR%. 
Editing notes in %GREEN%green font%ENDCOLOR%. 
 
---++ Reviewing Notes
Similar to Option 2 of [[ReportCallingPath]]  


---++ Comments 


1) I fixed the LCS number.

2) I think the tool should be enhanced instead to include more information in the report statement. Simulator brand &#34;M&#34; already shows the complete instance path the block which contains the report statement (in a process).

-- %BUBBLESIG{MartinZabel - 2017-02-15}%


@MZ.   Whether the user wants it or not, the report statement should provide this information?   
This proposal provides a simple way for a user to do this on their own:

report &#34;Yada Yada&#34; & to_string(MySubprogram&#39;CALL_SIMPLE_NAME) ; 

Why don&#39;t you show us how you are going to get the report statement to print this information when requested.   You might get something slightly less complex, but it will only work exactly where you define it - report statements.   For those of us who don&#39;t use the report statement, this give us the option to be able to print the information before calling std.env.stop (which I would prefer to stop quietly).

-- %BUBBLESIG{JimLewis - 2017-02-18}%


I have updated the proposal to show the trade-offs between a solution with report vs. a solution with &#39;CALL_SIMPLE_NAME

-- %BUBBLESIG{JimLewis - 2017-02-18}%

Suggested changes for 5.3.2.3 Predefined array types:
   * change =CALL_PATH_ARRAY_TYPE= to =CALL_PATH_VECTOR=
   * ... predefined %RED%record%ENDCOLOR% type CALL_PATH_TYPE ...

Suggested changes for 5.3.2.4 Predefined operations on array types
   * use another default separator sign: TAB or LF, because a call_path will never fit onto one simulator console line

Suggested changes for 5.3.3.2 Predefined record types
   * change name of =CALL_PATH_TYPE= to =CALL_PATH_ELEMENT=
   * Record element =CurrentLineNumber= should be of type =POSITIVE= instead of =INTEGER=

Suggested changes for 5.3.3.3 Predefined operations on record types
   * =TO_STRING= should also have a =Separator= parameter, defaulted to colon

Suggested changes for 5.3.4.4 Predefined access types
   * Now the access type name can be simplified to =CALL_STACK=

-- %BUBBLESIG{PatrickLehmann - 2017-02-19}%


I suggest the type names:
   * =CALL_PATH_ELEMENT=
   * =CALL_PATH_VECTOR=
   * =CALL_PATH=
To get rid of the =_TYPE= suffix.

-- %BUBBLESIG{PatrickLehmann - 2017-03-14}%


Some typos
   * _type CALL_PATH_ELEMENT is record_ - Both =CALL_PATH_ELEMENT= and =CALL_PATH_TYPE= is used in the text
   * _either the name a subprogram or the name of the construct_ - Missing an _of_
   * _name element of each record, except the last one, contains_ - Maybe _last one_ shoud be replaced by _rightmost one_. Not sure if _last_ means the same for people reading from right to left...
   * _The overloaded function TO_STRING[CALL_PATH_VECTOR, STRING return STRING] converts a CALL_PATH_TYPE to type STRING._ - =CALL_PATH_TYPE= -&#62; =CALL_PATH_VECTOR=
   * _The overloaded function TO_STRING[CALL_PATH_VECTOR_PTR, STRING return STRING] converts a CALL_PATH_TYPE to type STRING._  - =CALL_PATH_TYPE =-&#62; =CALL_PATH_VECTOR_PTS=


-- %BUBBLESIG{LarsAsplund - 2017-03-23}%
%COMMENT%</sticky>

</noautolink>
Topic revision: r2 - 2017-04-24 - 22:18:48 - JimLewis
P1076