wroclaw-git-backups/nix
1
0
Fork 0
mirror of https://github.com/NixOS/nix synced 2025-06-25 23:11:16 +02:00
Code Activity

nix_api_external: own return strings on the nix side

Browse source 
Change from nix_returned_string that passes ownership, into a
nix_string_return parameter that can be set using nix_set_string_return.
This commit is contained in:
Yorick van Pelt 2023-07-28 10:03:08 +02:00 • committed by José Luis Lafuente
parent 022b918db1
commit bebee700ea
No known key found for this signature in database
GPG key ID: 8A3455EBE455489A
2 changed files with 37 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

49
src/libexpr/nix_api_external.h
View file

@ -17,9 +17,10 @@ extern "C" {
// cffi start
/**
* @brief Represents a string meant for consumption by nix.
* @brief Represents a string owned by nix.
* @see nix_set_owned_string
*/
typedef struct nix_returned_string nix_returned_string;
typedef struct nix_string_return nix_string_return;
/**
* @brief Wraps a stream that can output multiple string pieces.
*/
@ -30,23 +31,13 @@ typedef struct nix_printer nix_printer;
typedef struct nix_string_context nix_string_context;
/**
* @brief Allocate a nix_returned_string from a const char*.
* @brief Sets the contents of a nix_string_return
*
* Copies the passed string.
* @param[in] c The string to copy
* @returns A nix_returned_string*
* @param[out] str the nix_string_return to write to
* @param[in] c The string to copy
*/
nix_returned_string *nix_external_alloc_string(const char *c);
/**
* @brief Deallocate a nix_returned_string
*
* There's generally no need to call this, since
* returning the string will pass ownership to nix,
* but you can use it in case of errors.
* @param[in] str The string to deallocate
*/
void nix_external_dealloc_string(nix_returned_string *str);
void nix_set_string_return(nix_string_return *str, const char *c);
/**
* Print to the nix_printer
@ -91,15 +82,15 @@ typedef struct NixCExternalValueDesc {
/**
* @brief Called on :t
* @param[in] self the void* passed to nix_create_external_value
* @returns a nix_returned_string, ownership passed to nix
* @param[out] res the return value
*/
nix_returned_string *(*showType)(void *self); // std::string
void (*showType)(void *self, nix_string_return *res);
/**
* @brief Called on `builtins.typeOf`
* @param self the void* passed to nix_create_external_value
* @returns a nix_returned_string, ownership passed to nix
* @param[out] res the return value
*/
nix_returned_string *(*typeOf)(void *self); // std::string
void (*typeOf)(void *self, nix_string_return *res);
/**
* @brief Called on "${str}" and builtins.toString.
*
@ -111,11 +102,11 @@ typedef struct NixCExternalValueDesc {
* instead of throwing an error
* @param[in] copyToStore boolean, whether to copy referenced paths to store
* or keep them as-is
* @returns a nix_returned_string, ownership passed to nix. Optional,
* returning NULL will make the conversion throw an error.
* @param[out] res the return value. Not touching this, or setting it to the
* empty string, will make the conversion throw an error.
*/
nix_returned_string *(*coerceToString)(void *self, nix_string_context *c,
int coerceMore, int copyToStore);
void (*coerceToString)(void *self, nix_string_context *c, int coerceMore,
int copyToStore, nix_string_return *res);
/**
* @brief Try to compare two external values
*
@ -138,12 +129,12 @@ typedef struct NixCExternalValueDesc {
* @param[out] c writable string context for the resulting string
* @param[in] copyToStore whether to copy referenced paths to store or keep
* them as-is
* @returns string that gets parsed as json. Optional, returning NULL will
* make the conversion throw an error.
* @param[out] res the return value. Gets parsed as JSON. Not touching this,
* or setting it to the empty string, will make the conversion throw an error.
*/
nix_returned_string *(*printValueAsJSON)(void *self, State *, int strict,
nix_string_context *c,
bool copyToStore);
void (*printValueAsJSON)(void *self, State *, int strict,
nix_string_context *c, bool copyToStore,
nix_string_return *res);
/**
* @brief Convert the external value to XML
*