Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add proxy flag and category to interfaces #87

Merged
merged 14 commits into from
May 22, 2021
+56 −19
Merged

Add proxy flag and category to interfaces #87

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
42ce6fc
Remove obsolete header nesting
schneidermic0 May 12, 2021
791dad9
Add category and proxy to interfaces
schneidermic0 May 12, 2021
5db90a3
Fix wrong content in zif_aff_types_v1
schneidermic0 May 12, 2021
656c452
Add content of zif_aff_intf_v1
schneidermic0 May 12, 2021
26c9e01
remove trailing whitespace
larshp May 12, 2021
3d3d9c5
remove newline?
larshp May 12, 2021
f281f4b
Merge branch 'main' into fix/intf
larshp May 12, 2021
5e1aecb
Remove final new line
schneidermic0 May 12, 2021
d351158
Update file-formats/intf/format.md
schneidermic0 May 12, 2021
ea04fec
Merge branch 'main' into fix/intf
larshp May 21, 2021
1079230
Update zif_aff_types_v1.intf.abap
larshp May 21, 2021
9209f1d
Fix line endings
schneidermic0 May 21, 2021
7debf18
Update file-formats/intf/zif_aff_types_v1.intf.abap
schneidermic0 May 21, 2021
4b96353
Fix line endings
schneidermic0 May 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion file-formats/intf/format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,6 @@ Example files for an interface `zif_aff_example` are provided in the following t
File | Content
--- | ---
[`zif_aff_example.intf.json`](./examples/zif_aff_example.intf.json) | Properties and descriptions of the ABAP interface
[`zif_aff_example.intf.abap`](./examples/zif_aff_example.intf.abap) | Interface source code
[`zif_aff_example.intf.abap`](./examples/zif_aff_example.intf.abap) | Interface source code

Documentation of interaces is not covered, yet.
schneidermic0 marked this conversation as resolved.
Show resolved Hide resolved
22 changes: 22 additions & 0 deletions file-formats/intf/intf.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,28 @@
"abapLanguageVersion"
]
},
"category": {
"title": "Interface category",
"description": "Interface category",
"type": "string",
"enum": [
"standard",
"classicBadi",
"dbProcedureProxy",
"enterpriseService"
],
"enumDescriptions": [
"Standard interface",
"Interface definition of a classic BAdI",
"Generated interface of a database procedure proxy",
"Generated interface of enterprise services"
]
},
"proxy": {
"title": "Interface is a proxy interface",
"description": "Interface is a proxy interface",
"type": "boolean"
},
"types": {
"type": "array",
"title": "Type Descriptions",
Expand Down
26 changes: 22 additions & 4 deletions file-formats/intf/zif_aff_intf_v1.intf.abap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
INTERFACE zif_aff_intf_v1 PUBLIC.

TYPES:
category_base TYPE n LENGTH 2,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a false-positive, isn't it? The type is used in the ENUM below as base type

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that looks like a false positive, I'll fix it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me know, if I shall add an issue to abaplint

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

abaplint/abaplint#1953

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@larshp Thanks

"! Interface category
BEGIN OF ENUM category BASE TYPE category_base,
"! Standard interface
standard VALUE IS INITIAL,
"! Interface definition of a classic BAdI
classic_badi VALUE '01',
"! Generated interface of a database procedure proxy
db_procedure_proxy VALUE '65',
"! Generated interface of enterprise services
enterprise_service VALUE '90',
END OF ENUM category.

TYPES:
"! Component description (e.g., for methods, attributes, types)
BEGIN OF component_description,
Expand All @@ -20,9 +34,9 @@ INTERFACE zif_aff_intf_v1 PUBLIC.
"! Description of the component
description TYPE zif_aff_types_v1=>description_60,
"! Parameter descriptions
parameters TYPE subcomponent_descriptions,
parameters TYPE subcomponent_descriptions,
"! Exception descriptions
exceptions TYPE subcomponent_descriptions,
exceptions TYPE subcomponent_descriptions,
END OF method,
"! Method descriptions
methods TYPE SORTED TABLE OF method WITH UNIQUE KEY name.
Expand All @@ -35,15 +49,19 @@ INTERFACE zif_aff_intf_v1 PUBLIC.
"! Description of the component
description TYPE zif_aff_types_v1=>description_60,
"! Parameter descriptions
parameters TYPE subcomponent_descriptions,
parameters TYPE subcomponent_descriptions,
END OF event,
"! Event descriptions
events TYPE SORTED TABLE OF event WITH UNIQUE KEY name.

TYPES:
"! Interface properties
BEGIN OF main,
header TYPE zif_aff_types_v1=>head-header,
header TYPE zif_aff_types_v1=>header,
"! Interface category
category TYPE category,
"! Interface is a proxy interface
proxy TYPE abap_bool,
"! Type descriptions
types TYPE component_descriptions,
"! Attribute descriptions
Expand Down
23 changes: 9 additions & 14 deletions file-formats/intf/zif_aff_types_v1.intf.abap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,15 @@ INTERFACE zif_aff_types_v1 PUBLIC.
END OF ENUM abap_language_version.

TYPES:
"! Head to be included in each object type
BEGIN OF head,
"! Location of the corresponding JSON schema
schema TYPE string,
schneidermic0 marked this conversation as resolved.
Show resolved Hide resolved
"! The header for an ABAP main object
BEGIN OF header,
"! Description of the ABAP object
description TYPE string,
"! Original language of the ABAP object
master_language TYPE language,
"! ABAP language version
abap_langu_version TYPE abap_language_version,
END OF header,
END OF head.
"! The header for an ABAP main object
BEGIN OF header,
"! Description of the ABAP object
description TYPE string,
"! Original language of the ABAP object
master_language TYPE language,
"! ABAP language version
abap_langu_version TYPE abap_language_version,
END OF header.

"! Description with 60 characters
TYPES description_60 TYPE c LENGTH 60.
Expand Down