Skip to content

n-api: add string api for latin1 encoding and new test cases #12368

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

Closed
sampsongao wants to merge 4 commits into from
Closed

n-api: add string api for latin1 encoding and new test cases #12368

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b6d9eee
n-api: add string api for latin1 encoding and new test cases
Apr 12, 2017
f506579
n-api: update the comment for string api changes
Apr 12, 2017
4f110e8
n-api: add test cases for latin1 encoding character set
Apr 12, 2017
c3faab1
n-api: update comment for string api to indicate sufficient buffer size
Apr 12, 2017
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
Prev Previous commit
Next Next commit
n-api: update the comment for string api changes
  • Loading branch information
Sampson Gao
Sampson Gao committed Apr 12, 2017
commit f5065794bb19ecacdf75d7734669c3b239c88f43
16 changes: 8 additions & 8 deletions src/node_api.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1734,8 +1734,8 @@ napi_status napi_get_value_string_length(napi_env env,
}

// Copies a JavaScript string into a LATIN-1 string buffer. The result is the
// number of bytes copied into buf, including the null terminator. If bufsize
// is insufficient, the string will be truncated, including a null terminator.
// number of bytes (excluding the null terminator) copied into buf.
// If bufsize is insufficient, the string will be truncated and null terminated.
// If buf is NULL, this method returns the length of the string (in bytes)
// via the result parameter.

@mhdawson mhdawson Apr 12, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can we clarify here that the length of the string does not include space for the terminator and that you should pass in a buffer of length+1 to avoid truncation ?

// The result argument is optional unless buf is NULL.
Expand Down Expand Up @@ -1767,8 +1767,8 @@ napi_status napi_get_value_string_latin1(napi_env env,
}

// Copies a JavaScript string into a UTF-8 string buffer. The result is the
// number of bytes copied into buf, including the null terminator. If bufsize
// is insufficient, the string will be truncated, including a null terminator.
// number of bytes (excluding the null terminator) copied into buf.
// If bufsize is insufficient, the string will be truncated and null terminated.
// If buf is NULL, this method returns the length of the string (in bytes)
// via the result parameter.
// The result argument is optional unless buf is NULL.
Expand Down Expand Up @@ -1800,10 +1800,10 @@ napi_status napi_get_value_string_utf8(napi_env env,
}

// Copies a JavaScript string into a UTF-16 string buffer. The result is the
// number of 2-byte code units copied into buf, including the null terminator.
// If bufsize is insufficient, the string will be truncated, including a null
// terminator. If buf is NULL, this method returns the length of the string
// (in 2-byte code units) via the result parameter.
// number of 2-byte code units (excluding the null terminator) copied into buf.
// If bufsize is insufficient, the string will be truncated and null terminated.
// If buf is NULL, this method returns the length of the string (in 2-byte

@mhdawson mhdawson Apr 12, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Same comment here as above to explain a buffer of length+1 should be passed in

// code units) via the result parameter.
// The result argument is optional unless buf is NULL.
napi_status napi_get_value_string_utf16(napi_env env,
napi_value value,
Expand Down