messages 2.42 KB
Newer Older
Neil Turton's avatar
Neil Turton committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/* Copyright 1996 Acorn Computers Ltd
 *
 * 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.
 */
/* File:    messages.h
 * Purpose: accessing an Object modules messages file (inc error reporting)
 * Author:  Timothy Roddis
 * History: 24-Jan-94: IDJ: created from original TGR sources
 */

#include "kernel.h"

#ifndef __toolbox_h
24
#include "objects/toolbox.h"
Neil Turton's avatar
Neil Turton committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
#endif


/* ------------------------------------ raising errors ---------------------------------------- */


extern _kernel_oserror *make_error (int err_num, int num_args, ...);
   /*
    * Generate a RISC OS error block.
    */



extern _kernel_oserror *make_error_hex (int err_num, int num_args, ...);
   /*
    * Generate a RISC OS error block, with integer params printed in hex.
    */



extern void raise_toolbox_error (int err_num, ObjectID object_id, ComponentID component_id, int num_args, ...);
   /*
    * Raise a Toolbox_Error event
    */



extern void raise_toolbox_error_hex (int err_num, ObjectID object_id, ComponentID component_id, int num_args, ...);
   /*
    * Raise a Toolbox_Error event, with integer parameters printed in hex
    */



extern void raise_toolbox_oserror (_kernel_oserror *e, ObjectID object_id, ComponentID component_id);
   /*
    * Raise a Toolbox_Error event, given a RISC OS error block
    */



/* --------------------------------------- message file handling ------------------------------ */


extern _kernel_oserror *messages_file_open (char *messages_filename);
    /*
     * Open the module's messages file (and cache file descriptor)
     */



extern _kernel_oserror *messages_file_close (void);
    /*
     * Close the module's messages file
     */



extern _kernel_oserror *messages_file_lookup (char *token, char *buffer, int *buffer_size, int num_args, ...);
    /*
     * Lookup given token in message file.
     * Result is placed in buffer, unless buffer == NULL, in which case
     * the size of buffer required is returned in *buffer_size
     */