Imported Upstream version 0.2.0+beta
[debian/yforth] / block.h
1 /* yForth? - A Forth interpreter written in ANSI C
2  * Copyright (C) 2012 Luca Padovani
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  * ------------------------------------------------------------------------
17  * Module name:     block.h
18  * Abstract:        Block word set header file
19  */
20
21 #ifdef DECLARE_WORDS
22 #       ifdef PROTOTYPES
23 #               undef PROTOTYPES
24 #       endif
25 #       undef __BLOCK_H__
26 #else
27 #       ifndef PROTOTYPES
28 #               define PROTOTYPES
29 #       endif
30 #endif
31
32 #ifndef __BLOCK_H__
33 #define __BLOCK_H__
34
35 #include "yforth.h"
36 #include "macro.h"
37
38 /**************************************************************************/
39 /* VARIABLES **************************************************************/
40 /**************************************************************************/
41
42 #ifdef PROTOTYPES
43
44 struct _block_data {                /* Entry in the table of blocks */
45     UCell block_no;                 /* Block number */
46     Cell dirty;                     /* Block updated */
47 };
48
49 struct _block_buffer {              /* Simply an array of Char */
50         Char buffer[BLOCK_SIZE];
51 };
52
53 extern FILE *block_file;
54
55 extern struct _block_data *block_data;
56 extern struct _block_buffer *block_buffer;
57
58 extern UCell current_block;
59
60 #endif
61
62 variable(UCell, b_l_k,                                          "blk")
63
64 /**************************************************************************/
65 /* PROTOTYPES *************************************************************/
66 /**************************************************************************/
67
68 code(block,                                     "block",                                        0)
69 code(buffer,                            "buffer",                                       0)
70 code(flush,                                     "flush",                                        0)
71 code(load,                                      "load",                                         0)
72 code(save_buffers,                      "save-buffers",                         0)
73 code(update,                            "update",                                       0)
74
75 #ifdef PROTOTYPES
76
77 /**************************************************************************/
78 /* AUXILIARY FUNCTIONS PROTOTYPES *****************************************/
79 /**************************************************************************/
80
81 int search_block(UCell block_no);
82 int allocate_block(UCell block_no, int load);
83 void load_block(UCell block_no, int b);
84 void save_block(int b);
85 int open_block_file(char *name);
86 void close_block_file(void);
87
88 #endif
89
90 #endif
91