1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2014 Johan Kayser <kayser.johan@gmail.com>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Provides PNaCl support for Nit.
19 # To use this module and compile for PNaCl, you must install the
20 # NaCl SDK (This file is based on Pepper 33).
21 # If NACL_SDK_ROOT is not set in your PATH, you have to work in
22 # 'nacl_sdk/pepper_your_pepper_version/getting_started/your_project_folder'.
23 module pnacl
is platform
26 intrude import standard
::stream
29 #include "ppapi/c/pp_errors.h"
30 #include "ppapi/c/ppp.h"
31 #include "ppapi/c/ppp_instance.h"
32 #include "ppapi/c/pp_bool.h"
33 #include "ppapi/c/ppb_var.h"
34 #include "ppapi/c/ppb_messaging.h"
35 #include "ppapi/c/ppp_messaging.h"
36 #include "ppapi/c/ppb_var_dictionary.h"
37 #include "ppapi/c/ppb_var_array.h"
48 #define MAX_DICTIONARY_QUEUE_SIZE 200
49 #define MAX_MESSAGE_QUEUE_SIZE 10
51 extern int nit_main(int, char**);
53 /* A working thread for Nit. */
54 static pthread_t g_nit_thread;
56 /* Mutex that guards the queues. */
57 static pthread_mutex_t g_dictionary_queue_mutex;
58 static pthread_mutex_t g_message_queue_mutex;
60 /* Condition variables that are signalled when the queues are not empty. */
61 static pthread_cond_t g_dictionary_queue_not_empty_cond;
62 static pthread_cond_t g_message_queue_not_empty_cond;
64 /** Circular queues of dictionaries and messages from JavaScript to be handled.
66 * If g_queue_start < g_queue_end:
67 * all elements in the range [g_queue_start, g_queue_end) are valid.
68 * If g_queue_start > g_queue_end:
69 * all elements in the ranges [0, g_queue_end) and
70 * [g_queue_start, MAX_QUEUE_SIZE) are valid.
71 * If g_queue_start == g_queue_end, and g_queue_size > 0:
72 * all elements in the g_queue are valid.
73 * If g_queue_start == g_queue_end, and g_queue_size == 0:
74 * No elements are valid. */
75 static struct PP_Var g_dictionary_queue[MAX_DICTIONARY_QUEUE_SIZE];
76 static char* g_message_queue[MAX_MESSAGE_QUEUE_SIZE];
78 /* The index of the head of the queues. */
79 static int g_dictionary_queue_start = 0;
80 static int g_message_queue_start = 0;
82 /* The index of the tail of the queues, non-inclusive. */
83 static int g_dictionary_queue_end = 0;
84 static int g_message_queue_end = 0;
86 /* The size of the queues. */
87 static int g_dictionary_queue_size = 0;
88 static int g_message_queue_size = 0;
90 /* PNaCl interfaces. */
91 const PPB_Messaging* g_varMessagingInterface;
92 const PPB_Var* g_varInterface;
93 const PPB_VarDictionary* g_varDictionaryInterface;
94 const PPB_VarArray* g_varArrayInterface;
96 PP_Instance g_instance;
99 /* A wrapper to launch the Nit main on a new thread. */
100 void* WrapperNitMain(void* arg) {
105 /** Return whether the queues are empty.
107 * NOTE: this function assumes g_queue_mutex lock is held.
108 * @return non-zero if the queue is empty. */
109 static int IsDictionaryQueueEmpty() { return g_dictionary_queue_size == 0; }
110 static int IsMessageQueueEmpty() { return g_message_queue_size == 0; }
112 /** Return whether the queues are full.
114 * NOTE: this function assumes g_queue_mutex lock is held.
115 * @return non-zero if the queue is full. */
116 static int IsDictionaryQueueFull() { return g_dictionary_queue_size == MAX_DICTIONARY_QUEUE_SIZE; }
117 static int IsMessageQueueFull() { return g_message_queue_size == MAX_MESSAGE_QUEUE_SIZE; }
119 /* Initialize the queues. */
120 void InitializeQueues() {
121 pthread_mutex_init(&g_dictionary_queue_mutex, NULL);
122 pthread_cond_init(&g_dictionary_queue_not_empty_cond, NULL);
123 pthread_mutex_init(&g_message_queue_mutex, NULL);
124 pthread_cond_init(&g_message_queue_not_empty_cond, NULL);
127 /** Enqueue a dictionary (i.e. add to the end)
129 * If the queue is full, the dictionary will be dropped.
131 * NOTE: this function assumes g_dictionary_queue_mutex is _NOT_ held.
132 * @param[in] dictionary, the dictionary to enqueue.
133 * @return non-zero if the dictionary was added to the queue. */
134 int EnqueueDictionary(struct PP_Var dictionary) {
135 pthread_mutex_lock(&g_dictionary_queue_mutex);
137 /* We shouldn't block the main thread waiting for the queue to not be full,
138 * so just drop the dictionary. */
139 if (IsDictionaryQueueFull()) {
140 pthread_mutex_unlock(&g_dictionary_queue_mutex);
144 g_dictionary_queue[g_dictionary_queue_end] = dictionary;
145 g_dictionary_queue_end = (g_dictionary_queue_end + 1) % MAX_DICTIONARY_QUEUE_SIZE;
146 g_dictionary_queue_size++;
148 pthread_cond_signal(&g_dictionary_queue_not_empty_cond);
150 pthread_mutex_unlock(&g_dictionary_queue_mutex);
155 /** Enqueue a message (i.e. add to the end)
157 * If the queue is full, the message will be dropped.
159 * NOTE: this function assumes g_message_queue_mutex is _NOT_ held.
160 * @param[in] message The message to enqueue.
161 * @return non-zero if the message was added to the queue. */
162 int EnqueueMessage(char* message) {
163 pthread_mutex_lock(&g_message_queue_mutex);
165 /* We shouldn't block the main thread waiting for the queue to not be full,
166 * so just drop the message. */
167 if (IsMessageQueueFull()) {
168 pthread_mutex_unlock(&g_message_queue_mutex);
172 g_message_queue[g_message_queue_end] = message;
173 g_message_queue_end = (g_message_queue_end + 1) % MAX_MESSAGE_QUEUE_SIZE;
174 g_message_queue_size++;
176 pthread_cond_signal(&g_message_queue_not_empty_cond);
178 pthread_mutex_unlock(&g_message_queue_mutex);
183 /** Dequeue a dictionary and return it.
185 * This function blocks until a dictionary is available. It should not be called
186 * on the main thread.
188 * NOTE: this function assumes g_dictionary_queue_mutex is _NOT_ held.
189 * @return The dictionary at the head of the queue. */
190 struct PP_Var DequeueDictionary() {
191 struct PP_Var dictionary = g_varDictionaryInterface->Create();
193 pthread_mutex_lock(&g_dictionary_queue_mutex);
195 while (IsDictionaryQueueEmpty()) {
196 pthread_cond_wait(&g_dictionary_queue_not_empty_cond, &g_dictionary_queue_mutex);
199 dictionary = g_dictionary_queue[g_dictionary_queue_start];
200 g_dictionary_queue_start = (g_dictionary_queue_start + 1) % MAX_DICTIONARY_QUEUE_SIZE;
201 g_dictionary_queue_size--;
203 pthread_mutex_unlock(&g_dictionary_queue_mutex);
208 /** Dequeue a message and return it.
210 * This function blocks until a message is available. It should not be called
211 * on the main thread.
213 * NOTE: this function assumes g_queue_mutex is _NOT_ held.
214 * @return The message at the head of the queue. */
215 char* DequeueMessage() {
216 char* message = NULL;
218 pthread_mutex_lock(&g_message_queue_mutex);
220 while (IsMessageQueueEmpty()) {
221 pthread_cond_wait(&g_message_queue_not_empty_cond, &g_message_queue_mutex);
224 message = g_message_queue[g_message_queue_start];
225 g_message_queue_start = (g_message_queue_start + 1) % MAX_MESSAGE_QUEUE_SIZE;
226 g_message_queue_size--;
228 pthread_mutex_unlock(&g_message_queue_mutex);
233 /* Posts a string message to JS. */
234 void PostMessage(char* message) {
235 /* Create PP_Var containing the message body. */
236 struct PP_Var varString = g_varInterface->VarFromUtf8(message, strlen(message));
238 /* Post message to the JavaScript layer. */
239 g_varMessagingInterface->PostMessage(g_instance, varString);
242 /* Posts a Dictionary (JS like object) to JS. */
243 void PostDictionary(struct PP_Var dictionary) {
244 g_varMessagingInterface->PostMessage(g_instance, dictionary);
247 /* Posts a Variable (aka PepperVar) to JS.
248 Should only be used for testing, conventional conversation is made
249 with Strings or Dictionaries. */
250 void PostVar(struct PP_Var v) {
251 g_varMessagingInterface->PostMessage(g_instance, v);
254 /* char* to PP_Var. */
255 static struct PP_Var CStrToVar(const char* str) {
256 if (g_varInterface != NULL) {
257 return g_varInterface->VarFromUtf8(str, strlen(str));
259 return PP_MakeUndefined();
262 static PP_Bool Instance_DidCreate(PP_Instance instance, uint32_t argc, const char* argn[], const char* argv[]) {
263 g_instance = instance;
265 /* Initialization of the queues and creation of the thread for Nit. */
267 pthread_create(&g_nit_thread, NULL, &WrapperNitMain, NULL);
272 static void Instance_DidDestroy(PP_Instance instance) {
276 static void Instance_DidChangeView(PP_Instance pp_instance, PP_Resource view) {
280 static void Instance_DidChangeFocus(PP_Instance pp_instance, PP_Bool has_focus) {
284 static PP_Bool Instance_HandleDocumentLoad(PP_Instance pp_instance, PP_Resource pp_url_loader) {
289 /* Called when JS sends something, is set to accept Strings or Dictionaries,
290 returns an error if received object is not a String or Dictionary. */
291 void Messaging_HandleMessage(PP_Instance instance, struct PP_Var varMessage) {
292 if(varMessage.type == PP_VARTYPE_DICTIONARY) {
293 if(!EnqueueDictionary(varMessage)) {
294 struct PP_Var errorMessage = CStrToVar("QueueFull : dropped dictionary because the queue was full.");
295 g_varMessagingInterface->PostMessage(g_instance, errorMessage);
298 else if(varMessage.type == PP_VARTYPE_STRING) {
300 char* message = (char*)g_varInterface->VarToUtf8(varMessage, &len);
301 if(!EnqueueMessage(message)) {
302 struct PP_Var errorMessage = CStrToVar("QueueFull : dropped message because the queue was full.");
303 g_varMessagingInterface->PostMessage(g_instance, errorMessage);
307 struct PP_Var errorMessage = CStrToVar("TypeError : only accepts JS objects or Strings");
308 g_varMessagingInterface->PostMessage(g_instance, errorMessage);
312 /* This function is called by Nit when using check_dictionary,
313 returns the dictionary at the head of the queue. */
314 void* NitHandleDictionary() {
315 struct PP_Var dictionary = DequeueDictionary();
316 PnaclApp_handle_dictionary(app, &dictionary);
320 /* This function is called By Nit when waiting for a user input. */
321 char* NitHandleMessage() {
322 return DequeueMessage();
326 PP_EXPORT int32_t PPP_InitializeModule(PP_Module module_id, PPB_GetInterface get_browser_interface) {
327 /* Initializing global pointers. */
328 g_varMessagingInterface = (const PPB_Messaging*) get_browser_interface(PPB_MESSAGING_INTERFACE);
329 g_varInterface = (const PPB_Var*) get_browser_interface(PPB_VAR_INTERFACE);
330 g_varDictionaryInterface = (const PPB_VarDictionary*) get_browser_interface(PPB_VAR_DICTIONARY_INTERFACE);
331 g_varArrayInterface = (const PPB_VarArray*) get_browser_interface(PPB_VAR_ARRAY_INTERFACE);
335 PP_EXPORT void PPP_ShutdownModule() {
339 PP_EXPORT const void* PPP_GetInterface(const char* interface_name) {
340 if (strcmp(interface_name, PPP_INSTANCE_INTERFACE) == 0)
342 static PPP_Instance instance_interface = {
344 &Instance_DidDestroy,
345 &Instance_DidChangeView,
346 &Instance_DidChangeFocus,
347 &Instance_HandleDocumentLoad
349 return &instance_interface;
351 else if (strcmp(interface_name, PPP_MESSAGING_INTERFACE) == 0) {
352 static PPP_Messaging messaging_interface = {
353 &Messaging_HandleMessage
355 return &messaging_interface;
360 /* Hack in order to avoid the problem with file. */
361 int poll(void *fds, int nfds, int timeout) { return 0; }
364 # Nit class representing a Pepper C API PP_Var typed as a Dictionary.
365 extern class PepperDictionary `{ struct PP_Var* `}
368 struct
PP_Var* recv
= malloc
( sizeof
( struct
PP_Var ) );
369 *recv
= g_varDictionaryInterface-
>Create();
373 # Get fonction using PepperVars.
375 # Returns the value that is associated with 'key'.
376 # If 'key' is not a String typed PepperVar, or doesn't exist in the Dictionary, an undefined PepperVar is returned.
377 fun native_get(key: PepperVar): PepperVar `{
378 struct
PP_Var* value
= malloc
( sizeof
( struct
PP_Var ) );
379 *value
= g_varDictionaryInterface-
>Get(*recv
, *key
);
383 # Returns the value associated with 'key'.
385 # 'key' must be a String.
386 # If 'key' is not a String or doesn't exist in the Dictionary, 'null' is returned.
387 fun [](key: nullable Pepperable): nullable Pepperable
389 var native_key = key.to_pepper
390 var native_value = native_get(native_key)
391 return native_value.to_nit
394 # Set function using PepperVars.
396 # Sets the value associated with the specified key.
397 # 'key' must be a String typed PepperVar.
398 # If 'key' hasn't existed in the Dictionary, it is added and associated with 'value'.
399 # Otherwise, the previous value is replaced with 'value'.
400 # Returns a Boolean indicating whether the operation succeeds.
401 fun native_set(key: PepperVar, value: PepperVar): Bool `{
403 b
= g_varDictionaryInterface-
>Set(*recv
, *key
, *value
);
407 # Sets the value associated with the specified key.
409 # 'key' must be a String.
410 # If 'key' hasn't existed in the Dictionary, it is added and associated with 'value'.
411 # Otherwise, the previous value is replaced with 'value'.
412 # Returns a Boolean indicating whether the operation succeeds.
413 fun []=(key: nullable Pepperable, value: nullable Pepperable): Bool
415 var native_key = key.to_pepper
416 var native_value = value.to_pepper
417 return native_set(native_key, native_value)
420 # Deletes the specified key and its associated value, if the key exists.
422 # Takes a String typed PepperVar.
423 fun native_delete(key: PepperVar) `{
424 g_varDictionaryInterface-
>Delete(*recv
, *key
);
427 # Deletes the specified key and its associated value, if the key exists.
430 fun delete(key: String)
432 var native_key = key.to_pepper
433 native_delete native_key
436 # Checks whether a key exists.
438 # Takes a String typed PepperVar.
439 fun native_has_key(key: PepperVar): Bool `{
441 b
= g_varDictionaryInterface-
>HasKey(*recv
, *key
);
445 # Checks whether a key exists.
448 fun has_key(key: String): Bool
450 var native_key = key.to_pepper
451 return native_has_key(native_key)
454 # Gets all the keys in a dictionary.
456 # Returns a PepperArray which contains all the keys of the Dictionary. The elements are string vars.
457 fun get_keys: PepperArray `{
458 struct
PP_Var* array
= malloc
( sizeof
( struct
PP_Var ) );
459 *array
= g_varDictionaryInterface-
>GetKeys(*recv
);
463 # Use this function to copy a dictionary.
464 fun copy: PepperDictionary `{
465 struct
PP_Var* varDictionary
= malloc
( sizeof
( struct
PP_Var ) );
466 *varDictionary
= g_varDictionaryInterface-
>Create();
467 *varDictionary
= *recv
;
468 return varDictionary
;
472 # Nit class representing a Pepper C API PP_Var typed as an Array.
473 extern class PepperArray `{ struct PP_Var* `}
476 struct PP_Var* recv = malloc( sizeof( struct PP_Var ) );
477 *recv = g_varArrayInterface->Create();
481 # Returns the element at the specified position as a PepperVar.
483 # If 'index' is larger than or equal to the array length, an undefined PepperVar is returned.
484 fun native_get
(index
: Int): PepperVar `{
485 struct PP_Var* value = malloc( sizeof( struct PP_Var ) );
486 *value = g_varArrayInterface->Get(*recv, index);
490 # Returns the element at the specified position.
492 # If 'index' is larger than or equal to the array length, 'null' is returned.
493 fun [](index
: Int): nullable Pepperable
495 var native_value
= native_get
(index
)
496 return native_value
.to_nit
499 # Returns an int containing the length of the PepperArray.
501 int length = g_varArrayInterface->GetLength(*recv);
505 # Takes a PepperVar for the 'value' param.
507 # Sets the value of an element in the array at indicated index.
508 # If 'index' is larger than or equal to the array length, the length is updated to be 'index' + 1.
509 # Any position in the array that hasn't been set before is set to undefined, i.e., PepperVar of C type PP_VARTYPE_UNDEFINED.
510 # Returns a Boolean indicating whether the operation succeeds.
511 fun native_set
(index
: Int, value
: PepperVar): Bool `{
513 b = g_varArrayInterface->Set(*recv, index, *value);
517 # Sets the value of an element in the array at indicated index.
519 # If 'index' is larger than or equal to the array length, the length is updated to be 'index' + 1.
520 # Any position in the array that hasn't been set before is set to undefined, i.e., PepperVar of C type PP_VARTYPE_UNDEFINED.
521 # Returns a Boolean indicating whether the operation succeeds.
522 fun []=(index
: Int, value
: nullable Pepperable): Bool
524 var native_value
= value
.to_pepper
525 return native_set
(index
, native_value
)
528 # Sets the array length.
530 # If 'length' is smaller than its current value, the array is truncated to the new length.
531 # Any elements that no longer fit are removed and the references to them will be released.
532 # If 'length' is larger than its current value, undefined PepperVars are appended to increase the array to the specified length.
533 # Returns a Boolean indicating whether the operation succeeds.
534 fun length
=(length
: Int): Bool `{
536 b = g_varArrayInterface->SetLength(*recv, length);
541 # Nit class representing a Pepper C API PP_Var.
542 extern class PepperVar `{ struct PP_Var* `}
545 return malloc
( sizeof
( struct
PP_Var ) );
548 # Converts PepperVar to standard types.
550 # Actually supports bools, ints, floats, strings. To be used with 'isa'.
551 fun to_nit: nullable Pepperable
553 if isa_null then return null
554 if isa_bool then return as_bool
555 if isa_int then return as_int
556 if isa_float then return as_float
557 if isa_string then return as_string
558 if is_undefined then return null
563 private fun isa_null: Bool `{ return recv->type == PP_VARTYPE_NULL; `}
564 private fun isa_bool
: Bool `{ return recv->type == PP_VARTYPE_BOOL; `}
565 private fun isa_int: Bool `{ return recv->type == PP_VARTYPE_INT32; `}
566 private fun isa_float
: Bool `{ return recv->type == PP_VARTYPE_DOUBLE; `}
567 private fun isa_string: Bool `{ return recv->type == PP_VARTYPE_STRING; `}
568 private fun is_undefined
: Bool `{ return recv->type == PP_VARTYPE_UNDEFINED; `}
570 private fun as_bool: Bool `{ return recv->value.as_bool; `}
571 private fun as_int
: Int `{ return recv->value.as_int; `}
572 private fun as_float: Float `{ return recv->value.as_double; `}
573 private fun as_string
: String import NativeString.to_s_with_length
`{
575 char* str = (char*)g_varInterface->VarToUtf8(*recv, &len);
576 return NativeString_to_s_with_length(str, len);
580 # Provides a method to convert in PepperVars.
582 fun to_pepper
: PepperVar is abstract
588 # Converts a Int into a PepperVar with Int type.
589 redef fun to_pepper
`{
590 struct PP_Var* var = malloc( sizeof( struct PP_Var ) );
591 *var = PP_MakeInt32(recv);
599 # Converts a Float into a PepperVar with Float type.
600 redef fun to_pepper
`{
601 struct PP_Var* var = malloc( sizeof( struct PP_Var ) );
602 *var = PP_MakeDouble(recv);
610 # Converts a Bool into a PepperVar with Bool type.
611 redef fun to_pepper
`{
612 struct PP_Var* var = malloc( sizeof( struct PP_Var ) );
613 *var = PP_MakeBool(recv);
621 # Converts a String into a PepperVar with String type.
622 redef fun to_pepper
: PepperVar import String.to_cstring
, String.length
`{
623 char *str = String_to_cstring(recv);
624 struct PP_Var* var = malloc( sizeof( struct PP_Var ) );
625 *var = g_varInterface->VarFromUtf8(str, String_length(recv));
630 # A stream for PNaCl, redefines basic input and output methods.
632 super PollableIStream
634 super BufferedIStream
636 init do prepare_buffer
(10)
638 redef var end_reached
: Bool = false
640 redef fun eof
do return end_reached
642 # Redefintion of 'write' to send messages to the browser.
643 redef fun write
(s
: Text) do app
.post_message s
.to_s
645 redef fun is_writable
: Bool do return true
647 # Checks if there is a message in the queue, and if so the message is handled automatically.
648 fun check_message
: NativeString `{
649 return NitHandleMessage();
652 # fill_buffer now checks for a message in the message queue which is filled by user inputs.
653 redef fun fill_buffer
657 _buffer
.append check_message
.to_s
661 # For a PNaCl app, Sys uses PnaclStreams.
663 fun pnacl_stdstr
: PnaclStream do return once
new PnaclStream
666 redef fun stdin
do return pnacl_stdstr
669 redef fun stdout
do return pnacl_stdstr
671 # NaCl output for errors.
672 redef fun stderr
do return pnacl_stdstr
675 # Class that provides the tools to interact with PNaCl.
678 # Sets everything up to work, need to be called at first.
679 fun initialize
import PnaclApp.handle_message
, PnaclApp.handle_dictionary
, NativeString.to_s_with_length
`{
683 # Posts a message to JS.
684 fun post_message
(message
: String) import String.to_cstring
`{
685 char* str = String_to_cstring(message);
689 # Posts a dictionary to JS.
690 fun post_dictionary
(dictionary
: PepperDictionary) `{
691 PostDictionary(*dictionary);
694 # Posts a PepperVar to JS.
696 # Should be used for testing, not recommanded for conventional conversation.
697 private fun post_var
(v
: PepperVar) `{
701 # Is called when a message is received from JS.
703 # Is set to be redefined in your application to handle like you want.
704 fun handle_message
(message
: String)
706 # To be Implemented by user.
709 # Is called when a Dictionary is received from JS.
711 # Is set to be redefined in your application to handle like you want.
712 # The dictionary is freed after this method returns.
713 fun handle_dictionary
(dictionary
: PepperDictionary)
715 # To be Implemented by user.
718 # Checks if there is a dictionary in the queue, and if so the dictionary is handled automatically.
719 fun check_dictionary
`{
720 NitHandleDictionary();
723 # Infinite loop on check_dictionary
732 # Creates a new thread for Nit.
734 # This function launches the Nit main on a new thread.
735 # Its purpose is to allow Nit to be still operational after an exit when needed,
736 # because reloading the page may not be an option.
738 # Should only be used within the 'exit' before stopping the current thread
739 # when the Nit execution causes a crash.
741 # REQUIRE: g_nit_thread and WrapperNitMain are set.
743 pthread_create(&g_nit_thread, NULL, &WrapperNitMain, NULL);
746 # Calls 'pthread_exit on current thread.
747 fun exit_thread
(exit_value
: Int) `{
748 pthread_exit((void*) exit_value);
751 # Redef of exit in order to avoid the module to crash by terminating only the Nit thread.
752 redef fun exit
(exit_value
: Int)
754 var dictionary
= new PepperDictionary
755 dictionary
["exit"] = exit_value
756 app
.post_dictionary dictionary
757 exit_thread exit_value
760 fun app
: PnaclApp do return once
new PnaclApp