Improve the jerry port api documents. (#4977)
Notable changes: - Remove the comments in port impl, that's easily getting to in-consistence - Sync the jerryscript-port.h and 05.PORT-API.md - Fixes the invalid comment in port codes JerryScript-DCO-1.0-Signed-off-by: Yonggang Luo luoyonggang@gmail.com
This commit is contained in:
@@ -20,12 +20,6 @@
|
||||
#include <sys/time.h>
|
||||
#include <time.h>
|
||||
|
||||
/**
|
||||
* Default implementation of jerry_port_local_tza.
|
||||
*
|
||||
* @return offset between UTC and local time at the given unix timestamp, if
|
||||
* available. Otherwise, returns 0, assuming UTC time.
|
||||
*/
|
||||
int32_t
|
||||
jerry_port_local_tza (double unix_ms)
|
||||
{
|
||||
@@ -53,11 +47,6 @@ jerry_port_local_tza (double unix_ms)
|
||||
#endif /* HAVE_TM_GMTOFF */
|
||||
} /* jerry_port_local_tza */
|
||||
|
||||
/**
|
||||
* Default implementation of jerry_port_current_time.
|
||||
*
|
||||
* @return milliseconds since Unix epoch
|
||||
*/
|
||||
double
|
||||
jerry_port_current_time (void)
|
||||
{
|
||||
|
||||
@@ -20,44 +20,26 @@
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
|
||||
/**
|
||||
* Normalize a file path using realpath.
|
||||
*
|
||||
* @param path_p: input path
|
||||
* @param path_size: input path size
|
||||
*
|
||||
* @return a newly allocated buffer with the normalized path if the operation is successful,
|
||||
* NULL otherwise
|
||||
*/
|
||||
jerry_char_t *
|
||||
jerry_port_path_normalize (const jerry_char_t *path_p, /**< input path */
|
||||
jerry_size_t path_size) /**< size of the path */
|
||||
jerry_port_path_normalize (const jerry_char_t *path_p, jerry_size_t path_size)
|
||||
{
|
||||
(void) path_size;
|
||||
|
||||
return (jerry_char_t *) realpath ((char *) path_p, NULL);
|
||||
} /* jerry_port_path_normalize */
|
||||
|
||||
/**
|
||||
* Free a path buffer returned by jerry_port_path_normalize.
|
||||
*/
|
||||
void
|
||||
jerry_port_path_free (jerry_char_t *path_p)
|
||||
{
|
||||
free (path_p);
|
||||
} /* jerry_port_path_free */
|
||||
|
||||
/**
|
||||
* Computes the end of the directory part of a path.
|
||||
*
|
||||
* @return end of the directory part of a path.
|
||||
*/
|
||||
jerry_size_t JERRY_ATTR_WEAK
|
||||
jerry_port_path_base (const jerry_char_t *path_p) /**< path */
|
||||
jerry_port_path_base (const jerry_char_t *path_p)
|
||||
{
|
||||
const jerry_char_t *basename_p = (jerry_char_t *) strrchr ((char *) path_p, '/') + 1;
|
||||
|
||||
return (jerry_size_t) (basename_p - path_p);
|
||||
} /* jerry_port_get_directory_end */
|
||||
} /* jerry_port_path_base */
|
||||
|
||||
#endif /* defined(__unix__) || defined(__APPLE__) */
|
||||
|
||||
@@ -25,11 +25,8 @@
|
||||
|
||||
#include <unistd.h>
|
||||
|
||||
/**
|
||||
* Default implementation of jerry_port_sleep, uses 'usleep'.
|
||||
*/
|
||||
void
|
||||
jerry_port_sleep (uint32_t sleep_time) /**< milliseconds to sleep */
|
||||
jerry_port_sleep (uint32_t sleep_time)
|
||||
{
|
||||
usleep ((useconds_t) sleep_time * 1000);
|
||||
} /* jerry_port_sleep */
|
||||
|
||||
Reference in New Issue
Block a user