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 # Targets the PNaCl platform
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'.
24 # Provides PNaCl support for Nit.
25 module pnacl
is platform
28 intrude import standard
::stream
31 #include "ppapi/c/pp_errors.h"
32 #include "ppapi/c/ppp.h"
33 #include "ppapi/c/ppp_instance.h"
34 #include "ppapi/c/pp_bool.h"
35 #include "ppapi/c/ppb_var.h"
36 #include "ppapi/c/ppb_messaging.h"
37 #include "ppapi/c/ppp_messaging.h"
38 #include "ppapi/c/ppb_var_dictionary.h"
39 #include "ppapi/c/ppb_var_array.h"
51 #define MAX_DICTIONARY_QUEUE_SIZE 200
52 #define MAX_MESSAGE_QUEUE_SIZE 10
54 extern int nit_main(int, char**);
56 /* A working thread for Nit. */
57 static pthread_t g_nit_thread;
59 /* Mutex that guards the queues. */
60 static pthread_mutex_t g_dictionary_queue_mutex;
61 static pthread_mutex_t g_message_queue_mutex;
63 /* Condition variables that are signalled when the queues are not empty. */
64 static pthread_cond_t g_dictionary_queue_not_empty_cond;
65 static pthread_cond_t g_message_queue_not_empty_cond;
67 /** Circular queues of dictionaries and messages from JavaScript to be handled.
69 * If g_queue_start < g_queue_end:
70 * all elements in the range [g_queue_start, g_queue_end) are valid.
71 * If g_queue_start > g_queue_end:
72 * all elements in the ranges [0, g_queue_end) and
73 * [g_queue_start, MAX_QUEUE_SIZE) are valid.
74 * If g_queue_start == g_queue_end, and g_queue_size > 0:
75 * all elements in the g_queue are valid.
76 * If g_queue_start == g_queue_end, and g_queue_size == 0:
77 * No elements are valid. */
78 static struct PP_Var g_dictionary_queue[MAX_DICTIONARY_QUEUE_SIZE];
79 static char* g_message_queue[MAX_MESSAGE_QUEUE_SIZE];
81 /* The index of the head of the queues. */
82 static int g_dictionary_queue_start = 0;
83 static int g_message_queue_start = 0;
85 /* The index of the tail of the queues, non-inclusive. */
86 static int g_dictionary_queue_end = 0;
87 static int g_message_queue_end = 0;
89 /* The size of the queues. */
90 static int g_dictionary_queue_size = 0;
91 static int g_message_queue_size = 0;
93 /* PNaCl interfaces. */
94 const PPB_Messaging* g_varMessagingInterface;
95 const PPB_Var* g_varInterface;
96 const PPB_VarDictionary* g_varDictionaryInterface;
97 const PPB_VarArray* g_varArrayInterface;
99 PP_Instance g_instance;
102 /* A wrapper to launch the Nit main on a new thread. */
103 void* WrapperNitMain(void* arg) {
108 /** Return whether the queues are empty.
110 * NOTE: this function assumes g_queue_mutex lock is held.
111 * @return non-zero if the queue is empty. */
112 static int IsDictionaryQueueEmpty() { return g_dictionary_queue_size == 0; }
113 static int IsMessageQueueEmpty() { return g_message_queue_size == 0; }
115 /** Return whether the queues are full.
117 * NOTE: this function assumes g_queue_mutex lock is held.
118 * @return non-zero if the queue is full. */
119 static int IsDictionaryQueueFull() { return g_dictionary_queue_size == MAX_DICTIONARY_QUEUE_SIZE; }
120 static int IsMessageQueueFull() { return g_message_queue_size == MAX_MESSAGE_QUEUE_SIZE; }
122 /* Initialize the queues. */
123 void InitializeQueues() {
124 pthread_mutex_init(&g_dictionary_queue_mutex, NULL);
125 pthread_cond_init(&g_dictionary_queue_not_empty_cond, NULL);
126 pthread_mutex_init(&g_message_queue_mutex, NULL);
127 pthread_cond_init(&g_message_queue_not_empty_cond, NULL);
130 /** Enqueue a dictionary (i.e. add to the end)
132 * If the queue is full, the dictionary will be dropped.
134 * NOTE: this function assumes g_dictionary_queue_mutex is _NOT_ held.
135 * @param[in] dictionary, the dictionary to enqueue.
136 * @return non-zero if the dictionary was added to the queue. */
137 int EnqueueDictionary(struct PP_Var dictionary) {
138 pthread_mutex_lock(&g_dictionary_queue_mutex);
140 /* We shouldn't block the main thread waiting for the queue to not be full,
141 * so just drop the dictionary. */
142 if (IsDictionaryQueueFull()) {
143 pthread_mutex_unlock(&g_dictionary_queue_mutex);
147 g_dictionary_queue[g_dictionary_queue_end] = dictionary;
148 g_dictionary_queue_end = (g_dictionary_queue_end + 1) % MAX_DICTIONARY_QUEUE_SIZE;
149 g_dictionary_queue_size++;
151 pthread_cond_signal(&g_dictionary_queue_not_empty_cond);
153 pthread_mutex_unlock(&g_dictionary_queue_mutex);
158 /** Enqueue a message (i.e. add to the end)
160 * If the queue is full, the message will be dropped.
162 * NOTE: this function assumes g_message_queue_mutex is _NOT_ held.
163 * @param[in] message The message to enqueue.
164 * @return non-zero if the message was added to the queue. */
165 int EnqueueMessage(char* message) {
166 pthread_mutex_lock(&g_message_queue_mutex);
168 /* We shouldn't block the main thread waiting for the queue to not be full,
169 * so just drop the message. */
170 if (IsMessageQueueFull()) {
171 pthread_mutex_unlock(&g_message_queue_mutex);
175 g_message_queue[g_message_queue_end] = message;
176 g_message_queue_end = (g_message_queue_end + 1) % MAX_MESSAGE_QUEUE_SIZE;
177 g_message_queue_size++;
179 pthread_cond_signal(&g_message_queue_not_empty_cond);
181 pthread_mutex_unlock(&g_message_queue_mutex);
186 /** Dequeue a dictionary and return it.
188 * This function blocks until a dictionary is available. It should not be called
189 * on the main thread.
191 * NOTE: this function assumes g_dictionary_queue_mutex is _NOT_ held.
192 * @return The dictionary at the head of the queue. */
193 struct PP_Var DequeueDictionary() {
194 struct PP_Var dictionary = g_varDictionaryInterface->Create();
196 pthread_mutex_lock(&g_dictionary_queue_mutex);
198 while (IsDictionaryQueueEmpty()) {
199 pthread_cond_wait(&g_dictionary_queue_not_empty_cond, &g_dictionary_queue_mutex);
202 dictionary = g_dictionary_queue[g_dictionary_queue_start];
203 g_dictionary_queue_start = (g_dictionary_queue_start + 1) % MAX_DICTIONARY_QUEUE_SIZE;
204 g_dictionary_queue_size--;
206 pthread_mutex_unlock(&g_dictionary_queue_mutex);
211 /** Dequeue a message and return it.
213 * This function blocks until a message is available. It should not be called
214 * on the main thread.
216 * NOTE: this function assumes g_queue_mutex is _NOT_ held.
217 * @return The message at the head of the queue. */
218 char* DequeueMessage() {
219 char* message = NULL;
221 pthread_mutex_lock(&g_message_queue_mutex);
223 while (IsMessageQueueEmpty()) {
224 pthread_cond_wait(&g_message_queue_not_empty_cond, &g_message_queue_mutex);
227 message = g_message_queue[g_message_queue_start];
228 g_message_queue_start = (g_message_queue_start + 1) % MAX_MESSAGE_QUEUE_SIZE;
229 g_message_queue_size--;
231 pthread_mutex_unlock(&g_message_queue_mutex);
236 /* Posts a string message to JS. */
237 void PostMessage(char* message) {
238 /* Create PP_Var containing the message body. */
239 struct PP_Var varString = g_varInterface->VarFromUtf8(message, strlen(message));
241 /* Post message to the JavaScript layer. */
242 g_varMessagingInterface->PostMessage(g_instance, varString);
245 /* Posts a Dictionary (JS like object) to JS. */
246 void PostDictionary(struct PP_Var dictionary) {
247 g_varMessagingInterface->PostMessage(g_instance, dictionary);
250 /* Posts a Variable (aka PepperVar) to JS.
251 Should only be used for testing, conventional conversation is made
252 with Strings or Dictionaries. */
253 void PostVar(struct PP_Var v) {
254 g_varMessagingInterface->PostMessage(g_instance, v);
257 /* char* to PP_Var. */
258 static struct PP_Var CStrToVar(const char* str) {
259 if (g_varInterface != NULL) {
260 return g_varInterface->VarFromUtf8(str, strlen(str));
262 return PP_MakeUndefined();
265 static PP_Bool Instance_DidCreate(PP_Instance instance, uint32_t argc, const char* argn[], const char* argv[]) {
266 g_instance = instance;
268 /* Initialization of the queues and creation of the thread for Nit. */
270 pthread_create(&g_nit_thread, NULL, &WrapperNitMain, NULL);
275 static void Instance_DidDestroy(PP_Instance instance) {
279 static void Instance_DidChangeView(PP_Instance pp_instance, PP_Resource view) {
283 static void Instance_DidChangeFocus(PP_Instance pp_instance, PP_Bool has_focus) {
287 static PP_Bool Instance_HandleDocumentLoad(PP_Instance pp_instance, PP_Resource pp_url_loader) {
292 /* Called when JS sends something, is set to accept Strings or Dictionaries,
293 returns an error if received object is not a String or Dictionary. */
294 void Messaging_HandleMessage(PP_Instance instance, struct PP_Var varMessage) {
295 if(varMessage.type == PP_VARTYPE_DICTIONARY) {
296 if(!EnqueueDictionary(varMessage)) {
297 struct PP_Var errorMessage = CStrToVar("QueueFull : dropped dictionary because the queue was full.");
298 g_varMessagingInterface->PostMessage(g_instance, errorMessage);
301 else if(varMessage.type == PP_VARTYPE_STRING) {
303 char* message = (char*)g_varInterface->VarToUtf8(varMessage, &len);
304 if(!EnqueueMessage(message)) {
305 struct PP_Var errorMessage = CStrToVar("QueueFull : dropped message because the queue was full.");
306 g_varMessagingInterface->PostMessage(g_instance, errorMessage);
310 struct PP_Var errorMessage = CStrToVar("TypeError : only accepts JS objects or Strings");
311 g_varMessagingInterface->PostMessage(g_instance, errorMessage);
315 /* This function is called by Nit when using check_dictionary,
316 returns the dictionary at the head of the queue. */
317 void* NitHandleDictionary() {
318 struct PP_Var dictionary = DequeueDictionary();
319 PnaclApp_handle_dictionary(app, &dictionary);
323 /* This function is called By Nit when waiting for a user input. */
324 char* NitHandleMessage() {
325 return DequeueMessage();
329 PP_EXPORT int32_t PPP_InitializeModule(PP_Module module_id, PPB_GetInterface get_browser_interface) {
330 /* Initializing global pointers. */
331 g_varMessagingInterface = (const PPB_Messaging*) get_browser_interface(PPB_MESSAGING_INTERFACE);
332 g_varInterface = (const PPB_Var*) get_browser_interface(PPB_VAR_INTERFACE);
333 g_varDictionaryInterface = (const PPB_VarDictionary*) get_browser_interface(PPB_VAR_DICTIONARY_INTERFACE);
334 g_varArrayInterface = (const PPB_VarArray*) get_browser_interface(PPB_VAR_ARRAY_INTERFACE);
338 PP_EXPORT void PPP_ShutdownModule() {
342 PP_EXPORT const void* PPP_GetInterface(const char* interface_name) {
343 if (strcmp(interface_name, PPP_INSTANCE_INTERFACE) == 0)
345 static PPP_Instance instance_interface = {
347 &Instance_DidDestroy,
348 &Instance_DidChangeView,
349 &Instance_DidChangeFocus,
350 &Instance_HandleDocumentLoad
352 return &instance_interface;
354 else if (strcmp(interface_name, PPP_MESSAGING_INTERFACE) == 0) {
355 static PPP_Messaging messaging_interface = {
356 &Messaging_HandleMessage
358 return &messaging_interface;
363 /* Hack in order to avoid the problem with file. */
364 int poll(struct pollfd* fds, nfds_t nfds, int timeout) { return 0; }
367 # Nit class representing a Pepper C API PP_Var typed as a Dictionary.
368 extern class PepperDictionary `{ struct PP_Var* `}
371 struct
PP_Var* recv
= malloc
( sizeof
( struct
PP_Var ) );
372 *recv
= g_varDictionaryInterface-
>Create();
376 # Get fonction using PepperVars.
378 # Returns the value that is associated with 'key'.
379 # If 'key' is not a String typed PepperVar, or doesn't exist in the Dictionary, an undefined PepperVar is returned.
380 fun native_get(key: PepperVar): PepperVar `{
381 struct
PP_Var* value
= malloc
( sizeof
( struct
PP_Var ) );
382 *value
= g_varDictionaryInterface-
>Get(*recv
, *key
);
386 # Returns the value associated with 'key'.
388 # 'key' must be a String.
389 # If 'key' is not a String or doesn't exist in the Dictionary, 'null' is returned.
390 fun [](key: nullable Pepperable): nullable Pepperable
392 var native_key = key.to_pepper
393 var native_value = native_get(native_key)
394 return native_value.to_nit
397 # Set function using PepperVars.
399 # Sets the value associated with the specified key.
400 # 'key' must be a String typed PepperVar.
401 # If 'key' hasn't existed in the Dictionary, it is added and associated with 'value'.
402 # Otherwise, the previous value is replaced with 'value'.
403 # Returns a Boolean indicating whether the operation succeeds.
404 fun native_set(key: PepperVar, value: PepperVar): Bool `{
406 b
= g_varDictionaryInterface-
>Set(*recv
, *key
, *value
);
410 # Sets the value associated with the specified key.
412 # 'key' must be a String.
413 # If 'key' hasn't existed in the Dictionary, it is added and associated with 'value'.
414 # Otherwise, the previous value is replaced with 'value'.
415 # Returns a Boolean indicating whether the operation succeeds.
416 fun []=(key: nullable Pepperable, value: nullable Pepperable): Bool
418 var native_key = key.to_pepper
419 var native_value = value.to_pepper
420 return native_set(native_key, native_value)
423 # Deletes the specified key and its associated value, if the key exists.
425 # Takes a String typed PepperVar.
426 fun native_delete(key: PepperVar) `{
427 g_varDictionaryInterface-
>Delete(*recv
, *key
);
430 # Deletes the specified key and its associated value, if the key exists.
433 fun delete(key: String)
435 var native_key = key.to_pepper
436 native_delete native_key
439 # Checks whether a key exists.
441 # Takes a String typed PepperVar.
442 fun native_has_key(key: PepperVar): Bool `{
444 b
= g_varDictionaryInterface-
>HasKey(*recv
, *key
);
448 # Checks whether a key exists.
451 fun has_key(key: String): Bool
453 var native_key = key.to_pepper
454 return native_has_key(native_key)
457 # Gets all the keys in a dictionary.
459 # Returns a PepperArray which contains all the keys of the Dictionary. The elements are string vars.
460 fun get_keys: PepperArray `{
461 struct
PP_Var* array
= malloc
( sizeof
( struct
PP_Var ) );
462 *array
= g_varDictionaryInterface-
>GetKeys(*recv
);
466 # Use this function to copy a dictionary.
467 fun copy: PepperDictionary `{
468 struct
PP_Var* varDictionary
= malloc
( sizeof
( struct
PP_Var ) );
469 *varDictionary
= g_varDictionaryInterface-
>Create();
470 *varDictionary
= *recv
;
471 return varDictionary
;
475 # Nit class representing a Pepper C API PP_Var typed as an Array.
476 extern class PepperArray `{ struct PP_Var* `}
479 struct PP_Var* recv = malloc( sizeof( struct PP_Var ) );
480 *recv = g_varArrayInterface->Create();
484 # Returns the element at the specified position as a PepperVar.
486 # If 'index' is larger than or equal to the array length, an undefined PepperVar is returned.
487 fun native_get
(index
: Int): PepperVar `{
488 struct PP_Var* value = malloc( sizeof( struct PP_Var ) );
489 *value = g_varArrayInterface->Get(*recv, index);
493 # Returns the element at the specified position.
495 # If 'index' is larger than or equal to the array length, 'null' is returned.
496 fun [](index
: Int): nullable Pepperable
498 var native_value
= native_get
(index
)
499 return native_value
.to_nit
502 # Returns an int containing the length of the PepperArray.
504 int length = g_varArrayInterface->GetLength(*recv);
508 # Takes a PepperVar for the 'value' param.
510 # Sets the value of an element in the array at indicated index.
511 # If 'index' is larger than or equal to the array length, the length is updated to be 'index' + 1.
512 # Any position in the array that hasn't been set before is set to undefined, i.e., PepperVar of C type PP_VARTYPE_UNDEFINED.
513 # Returns a Boolean indicating whether the operation succeeds.
514 fun native_set
(index
: Int, value
: PepperVar): Bool `{
516 b = g_varArrayInterface->Set(*recv, index, *value);
520 # Sets the value of an element in the array at indicated index.
522 # If 'index' is larger than or equal to the array length, the length is updated to be 'index' + 1.
523 # Any position in the array that hasn't been set before is set to undefined, i.e., PepperVar of C type PP_VARTYPE_UNDEFINED.
524 # Returns a Boolean indicating whether the operation succeeds.
525 fun []=(index
: Int, value
: nullable Pepperable): Bool
527 var native_value
= value
.to_pepper
528 return native_set
(index
, native_value
)
531 # Sets the array length.
533 # If 'length' is smaller than its current value, the array is truncated to the new length.
534 # Any elements that no longer fit are removed and the references to them will be released.
535 # If 'length' is larger than its current value, undefined PepperVars are appended to increase the array to the specified length.
536 # Returns a Boolean indicating whether the operation succeeds.
537 fun length
=(length
: Int): Bool `{
539 b = g_varArrayInterface->SetLength(*recv, length);
544 # Nit class representing a Pepper C API PP_Var.
545 extern class PepperVar `{ struct PP_Var* `}
548 return malloc
( sizeof
( struct
PP_Var ) );
551 # Converts PepperVar to standard types.
553 # Actually supports bools, ints, floats, strings. To be used with 'isa'.
554 fun to_nit: nullable Pepperable
556 if isa_null then return null
557 if isa_bool then return as_bool
558 if isa_int then return as_int
559 if isa_float then return as_float
560 if isa_string then return as_string
561 if is_undefined then return null
566 private fun isa_null: Bool `{ return recv->type == PP_VARTYPE_NULL; `}
567 private fun isa_bool
: Bool `{ return recv->type == PP_VARTYPE_BOOL; `}
568 private fun isa_int: Bool `{ return recv->type == PP_VARTYPE_INT32; `}
569 private fun isa_float
: Bool `{ return recv->type == PP_VARTYPE_DOUBLE; `}
570 private fun isa_string: Bool `{ return recv->type == PP_VARTYPE_STRING; `}
571 private fun is_undefined
: Bool `{ return recv->type == PP_VARTYPE_UNDEFINED; `}
573 private fun as_bool: Bool `{ return recv->value.as_bool; `}
574 private fun as_int
: Int `{ return recv->value.as_int; `}
575 private fun as_float: Float `{ return recv->value.as_double; `}
576 private fun as_string
: String import NativeString.to_s_with_length
`{
578 char* str = (char*)g_varInterface->VarToUtf8(*recv, &len);
579 return NativeString_to_s_with_length(str, len);
583 # Provides a method to convert in PepperVars.
585 fun to_pepper
: PepperVar is abstract
591 # Converts a Int into a PepperVar with Int type.
592 redef fun to_pepper
`{
593 struct PP_Var* var = malloc( sizeof( struct PP_Var ) );
594 *var = PP_MakeInt32(recv);
602 # Converts a Float into a PepperVar with Float type.
603 redef fun to_pepper
`{
604 struct PP_Var* var = malloc( sizeof( struct PP_Var ) );
605 *var = PP_MakeDouble(recv);
613 # Converts a Bool into a PepperVar with Bool type.
614 redef fun to_pepper
`{
615 struct PP_Var* var = malloc( sizeof( struct PP_Var ) );
616 *var = PP_MakeBool(recv);
624 # Converts a String into a PepperVar with String type.
625 redef fun to_pepper
: PepperVar import String.to_cstring
, String.length
`{
626 char *str = String_to_cstring(recv);
627 struct PP_Var* var = malloc( sizeof( struct PP_Var ) );
628 *var = g_varInterface->VarFromUtf8(str, String_length(recv));
633 # A stream for PNaCl, redefines basic input and output methods.
635 super PollableIStream
637 super BufferedIStream
639 init do prepare_buffer
(10)
641 redef var end_reached
: Bool = false
643 redef fun eof
do return end_reached
645 # Redefintion of 'write' to send messages to the browser.
646 redef fun write
(s
: Text) do app
.post_message s
.to_s
648 redef fun is_writable
: Bool do return true
650 # Checks if there is a message in the queue, and if so the message is handled automatically.
651 fun check_message
: NativeString `{
652 return NitHandleMessage();
655 # fill_buffer now checks for a message in the message queue which is filled by user inputs.
656 redef fun fill_buffer
660 _buffer
.append check_message
.to_s
664 # For a PNaCl app, Sys uses PnaclStreams.
666 fun pnacl_stdstr
: PnaclStream do return once
new PnaclStream
669 redef fun stdin
do return pnacl_stdstr
672 redef fun stdout
do return pnacl_stdstr
674 # NaCl output for errors.
675 redef fun stderr
do return pnacl_stdstr
678 # Class that provides the tools to interact with PNaCl.
681 # Sets everything up to work, need to be called at first.
682 fun initialize
import PnaclApp.handle_message
, PnaclApp.handle_dictionary
, NativeString.to_s_with_length
`{
686 # Posts a message to JS.
687 fun post_message
(message
: String) import String.to_cstring
`{
688 char* str = String_to_cstring(message);
692 # Posts a dictionary to JS.
693 fun post_dictionary
(dictionary
: PepperDictionary) `{
694 PostDictionary(*dictionary);
697 # Posts a PepperVar to JS.
699 # Should be used for testing, not recommanded for conventional conversation.
700 private fun post_var
(v
: PepperVar) `{
704 # Is called when a message is received from JS.
706 # Is set to be redefined in your application to handle like you want.
707 fun handle_message
(message
: String)
709 # To be Implemented by user.
712 # Is called when a Dictionary is received from JS.
714 # Is set to be redefined in your application to handle like you want.
715 # The dictionary is freed after this method returns.
716 fun handle_dictionary
(dictionary
: PepperDictionary)
718 # To be Implemented by user.
721 # Checks if there is a dictionary in the queue, and if so the dictionary is handled automatically.
722 fun check_dictionary
`{
723 NitHandleDictionary();
726 # Infinite loop on check_dictionary
735 # Creates a new thread for Nit.
737 # This function launches the Nit main on a new thread.
738 # Its purpose is to allow Nit to be still operational after an exit when needed,
739 # because reloading the page may not be an option.
741 # Should only be used within the 'exit' before stopping the current thread
742 # when the Nit execution causes a crash.
744 # REQUIRE: g_nit_thread and WrapperNitMain are set.
746 pthread_create(&g_nit_thread, NULL, &WrapperNitMain, NULL);
749 # Calls 'pthread_exit on current thread.
750 fun exit_thread
(exit_value
: Int) `{
751 pthread_exit((void*) exit_value);
754 # Redef of exit in order to avoid the module to crash by terminating only the Nit thread.
755 redef fun exit
(exit_value
: Int)
757 var dictionary
= new PepperDictionary
758 dictionary
["exit"] = exit_value
759 app
.post_dictionary dictionary
760 exit_thread exit_value
763 fun app
: PnaclApp do return once
new PnaclApp