mirror of
https://github.com/jerryscript-project/jerryscript.git
synced 2025-12-15 16:29:21 +00:00
ac1c48eeff
Notable changes:
- Updated and the port API interface, new functions have been added
and some have been changed. The port library is now cleaned up to
not have any dependency on jerry-core, as it should be. The port library
is now strictly a collection of functions that implement
embedding/platform specific behavior.
- The default port implementation has been split for windows and unix.
Implemented port functions have been categorized and reorganized,
and marked with attribute((weak)) for better reusability.
- External context allocation has been moved to the port API instead
of a core API callback. The iterface has also been extended with a
function to free the allocated context. When external context is
enabled, jerry_init now automatically calls the port implementation
to allocate the context and jerry_cleanup automatically calls the port
to free the context.
- jerry_port_log has been changed to no longer require formatting to
be implemented by the port. The reason beind this is that it was vague what
format specifiers were used by the engine, and in what manner. The port
function now takes a zero-terminated string, and should only implement
how the string should be logged.
- Logging and log message formatting is now handled by the core jerry library
where it can be implemented as necessary. Logging can be done through a new
core API function, which uses the port to output the final log message.
- Log level has been moved into jerry-core, and an API function has
been added to set the log level. It should be the library that
filters log messages based on the requested log level, instead of
logging everything and requiring the user to do so.
- Module resolving logic has been moved into jerry-core. There's no
reason to have it in the port library and requiring embedders to
duplicate the code. It also added an unnecessary dependency on
jerry-core to the port. Platform specific behavior is still used through
the port API, like resolving module specifiers, and reading source file
contents. If necessary, the resolving logic can still be overridden as
previously.
- The jerry-ext library has also been cleaned up, and many utility
functions have been added that previously were implemented in
jerry-main. This allows easier reusability for some common operations,
like printing unhandled exceptions or providing a repl console.
- Debugger interaction with logged/printed messages has been fixed, so
that it's no longer the port implementations responsibility to send
the output to the debugger, as the port should have no notion of what a
debugger is. The printing and logging functions will now pass the
result message to the debugger, if connected.
- Cleaned up TZA handling in the date port implementation, and simplified
the API function prototype.
- Moved property access helper functions that use ASCII strings as
keys from jerry-ext to the core API.
JerryScript-DCO-1.0-Signed-off-by: Dániel Bátyai dbatyai@inf.u-szeged.hu
83 lines
2.6 KiB
C
83 lines
2.6 KiB
C
/* Copyright JS Foundation and other contributors, http://js.foundation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef CLI_H
|
|
#define CLI_H
|
|
|
|
#include <stdint.h>
|
|
#include <string.h>
|
|
|
|
/**
|
|
* Command line option definition.
|
|
*/
|
|
typedef struct
|
|
{
|
|
int id; /**< unique ID of the option (CLI_OPT_DEFAULT, or anything >= 0) */
|
|
const char *opt; /**< short option variant (in the form of "x" without dashes) */
|
|
const char *longopt; /**< long option variant (in the form of "xxx" without dashes) */
|
|
const char *meta; /**< name(s) of the argument(s) of the option, for display only */
|
|
const char *help; /**< descriptive help message of the option */
|
|
} cli_opt_t;
|
|
|
|
/**
|
|
* Special marker for default option which also marks the end of the option list.
|
|
*/
|
|
#define CLI_OPT_DEFAULT -1
|
|
|
|
/**
|
|
* Returned by cli_consume_option () when no more options are available
|
|
* or an error occurred.
|
|
*/
|
|
#define CLI_OPT_END -2
|
|
|
|
/**
|
|
* State of the sub-command processor.
|
|
* No fields should be accessed other than error and arg.
|
|
*/
|
|
typedef struct
|
|
{
|
|
/* Public fields. */
|
|
const char *error; /**< public field for error message */
|
|
const char *arg; /**< last processed argument as string */
|
|
|
|
/* Private fields. */
|
|
int index; /**< current argument index */
|
|
int argc; /**< remaining number of arguments */
|
|
char **argv; /**< remaining arguments */
|
|
const cli_opt_t *opts; /**< options */
|
|
} cli_state_t;
|
|
|
|
/**
|
|
* Macro for writing command line option definition struct literals.
|
|
*/
|
|
#define CLI_OPT_DEF(...) /*(cli_opt_t)*/ \
|
|
{ \
|
|
__VA_ARGS__ \
|
|
}
|
|
|
|
/*
|
|
* Functions for CLI.
|
|
*/
|
|
|
|
cli_state_t cli_init (const cli_opt_t *options_p, int argc, char **argv);
|
|
void cli_change_opts (cli_state_t *state_p, const cli_opt_t *options_p);
|
|
int cli_consume_option (cli_state_t *state_p);
|
|
const char *cli_consume_string (cli_state_t *state_p);
|
|
int cli_consume_int (cli_state_t *state_p);
|
|
uint32_t cli_consume_path (cli_state_t *state_p);
|
|
void cli_help (const char *prog_name_p, const char *command_name_p, const cli_opt_t *options_p);
|
|
|
|
#endif /* !CLI_H */
|