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.

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

Allow natives to return structs and arrays. #988

Merged
merged 1 commit into from
Oct 26, 2024
Merged

Allow natives to return structs and arrays. #988

merged 1 commit into from
Oct 26, 2024

Conversation

dvander
Copy link
Member

@dvander dvander commented Oct 26, 2024

Natives can now return enum structs and fixed-size arrays. The address is passed as a hidden first parameter. For example:

native Struct DoStuff(int x, int y);

Will have:

params[0] = 3
params[1] = the address of the output struct
params[2] = x
params[3] = y

The native MUST return params[1] on success, otherwise, behavior is undefined.

It is recommended that when defining C++ definitions of SourcePawn structs, to use #pragma pack(push, 1) and #pragma pack(pop). In addition, the only types that should appear are "cell_t" and "float". No other type should be used for scalars. For arrays, "char" may be used, but not as a scalar.

When using char arrays, the C++ definition must be careful to convert the char size to a cell-aligned size. For example:

enum struct MyStruct {
    int x;
    int y;
    char message[50];
}

Should look like this in C++:

#pragma pack(push, 1)
struct MyStruct {
    cell_t x;
    cell_t y;
    char message[CharArraySize<50>::bytes];
};
#pragma pack(pop)

Natives can now return enum structs and fixed-size arrays. The address
is passed as a hidden first parameter. For example:

    native Struct DoStuff(int x, int y);

Will have:

    params[0] = 3
    params[1] = the address of the output struct
    params[2] = x
    params[3] = y

The hidden address points to a fully initialized array or enum struct.
In the case of a multi-dimensional array, the indirection vectors are
already placed. All values/members are initialized to zero.

The native MUST return params[1] on success, otherwise, behavior is
undefined.

It is recommended that when defining C++ definitions of SourcePawn
structs, to use `#pragma pack(push, 1)` and `#pragma pack(pop)`. In
addition, the only types that should appear are "cell_t" and "float". No
other type should be used for scalars. For arrays, "char" may be used,
but not as a scalar.

When using char arrays, the C++ definition must be careful to convert
the char size to a cell-aligned size. For example:

    enum struct MyStruct {
        int x;
        int y;
        char message[50];
    }

Should look like this in C++:

    #pragma pack(push, 1)
    struct MyStruct {
        cell_t x;
        cell_t y;
        char message[CharArraySize<50>::bytes];
    };
    #pragma pack(pop)
@dvander dvander merged commit 6e00170 into master Oct 26, 2024
19 checks passed
@dvander dvander deleted the rn branch October 26, 2024 04:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant