dojo_get_message.c

Go to the documentation of this file.

/*****************************************************************************
 * ugBASIC - an isomorphic BASIC language compiler for retrocomputers        *
 *****************************************************************************
 * Copyright 2021-2026 Marco Spedaletti (asimov@mclink.it)
 *
 * 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.
 *----------------------------------------------------------------------------
 * Concesso in licenza secondo i termini della Licenza Apache, versione 2.0
 * (la "Licenza"); è proibito usare questo file se non in conformità alla
 * Licenza. Una copia della Licenza è disponibile all'indirizzo:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Se non richiesto dalla legislazione vigente o concordato per iscritto,
 * il software distribuito nei termini della Licenza è distribuito
 * "COSÌ COM'È", SENZA GARANZIE O CONDIZIONI DI ALCUN TIPO, esplicite o
 * implicite. Consultare la Licenza per il testo specifico che regola le
 * autorizzazioni e le limitazioni previste dalla medesima.
 ****************************************************************************/
 
/****************************************************************************
 * INCLUDE SECTION 
 ****************************************************************************/
 
 #include "../../../ugbc.h"
 
 extern char DATATYPE_AS_STRING[][16];
 
/* <usermanual>
@keyword GET MESSAGE
 
@english
 
The ''GET MESSAGE'' statement allows you to retrieve the message present on the 
specified port (''port''), and possibly on the specific channel (''channel''). 
If used as a function, the message is returned as a string; otherwise,
the type of the given variable is used to parse the incoming type. If there are 
no messages at the time of the call, or if the port is unknown, an empty string 
will be returned or the given variable is untouched. The actual
error must be retrieved with the ''DOJO ERROR'' command. If you want to avoid 
fetching a message from an empty message queue, you can use the ''PEEK MESSAGE'' statement.
Note that ''MESSAGE'' keyword is optional.
 
@italian
 
L'istruzione ''GET MESSAGE'' permette di recuperare il messaggio presente sulla 
porta indicata (''port''), ed eventualmente sul canale specifico (''channel''). 
Il messaggio viene restituito come una stringa se si utilizza la notazione
in forma di funzione, mentre viene decodificato secondo il tipo utilizzato come
parametro, nell'altro caso. Se non vi sono messaggi al momento 
della chiamata, oppure se la porta è sconosciuta, sarà restituita una stringa vuota. 
L'errore effetivo va recuperato con il comando ''DOJO ERROR''. Se si vuole evitare 
di prelevare un messaggio da una coda messaggi vuota, è possibile usare l'istruzione 
''PEEK MESSAGE''. Da notare che la parola chiave ''MESSAGE'' è opzionale.
 
@syntax = [DOJO] GET [MESSAGE]( port[, channel] )
@syntax [DOJO] GET [MESSAGE] port[, channel], variable
 
@example message = GET MESSAGE( myPort, myChannel )
@example DIM a(42): GET MESSAGE myPort, 42, a
 
@alias DOJO GET MESSAGE
 
@seeAlso PEEK MESSAGE
@seeAlso DOJO ERROR
 
@target atari, coco
</usermanual> */
 
/* <usermanual>
@keyword DOJO GET MESSAGE
 
@english
 
@italian
 
@alias GET MESSAGE
 
@target atari, coco
</usermanual> */
 
 Variable * dojo_get_message( Environment * _environment, char * _port, char * _channel ) {
 
    MAKE_LABEL
 
    Variable * port = variable_retrieve_or_define( _environment, _port, VT_BYTE, 0 );
    Variable * channel = NULL;
    if ( _channel ) {
        channel = variable_retrieve_or_define( _environment, _channel, VT_BYTE, 0 );
    }
    Variable * result = variable_temporary( _environment, VT_DSTRING, "(result)");
    Variable * size = variable_temporary( _environment, VT_BYTE, "(size)");
    Variable * address = variable_temporary( _environment, VT_ADDRESS, "(size)");
    Variable * esito = variable_temporary( _environment, VT_BYTE, "(result)");
 
    if ( port->type != VT_DOJOKA ) {
        DOJO_PEEK_MESSAGE_DOJOKA_REQUIRED( _port, DATATYPE_AS_STRING[port->type]);
    }
 
    dojo_begin( _environment );
    dojo_put_requestds( _environment, DOJO_CMD_SELECT_PORT, NULL, NULL, port->realName, 4, esito->realName );
    cpu_compare_and_branch_8bit_const( _environment, esito->realName, 0, label, 0 );
    dojo_put_request0( _environment, DOJO_CMD_GET_MESSAGE, channel ? channel->realName : NULL, NULL, esito->realName );
    cpu_compare_and_branch_8bit_const( _environment, esito->realName, 0, label, 0 );
    dojo_partial( _environment );
    dojo_get_response_size( _environment, esito->realName, size->realName );
    cpu_dsalloc( _environment, size->realName, result->realName );
    cpu_dsdescriptor( _environment, result->realName, address->realName, NULL );
    dojo_get_response_payload( _environment, address->realName );
    dojo_end( _environment );
 
    cpu_label( _environment, label );
 
    cpu_move_8bit( _environment, esito->realName, "DOJOERROR" );
 
    return result;
    
}