lbm_image.h

Go to the documentation of this file.

/*
    Copyright 2025 Joel Svensson  svenssonjoel@yahoo.se
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LBM_IMAGE_H_
#define LBM_IMAGE_H_
 
typedef bool (*lbm_image_write_fun)(uint32_t data, int32_t index, bool const_heap);
 
uint32_t *lbm_image_get_image(void);
 
int32_t lbm_image_get_write_index(void);
 
uint32_t lbm_image_get_size(void);
 
bool lbm_image_has_extensions(void);
 
bool lbm_image_save_global_env(void);
 
bool lbm_image_save_extensions(void);
 
bool lbm_image_save_constant_heap_ix(void);
 
lbm_uint *lbm_image_add_symbol(char *name, lbm_uint id, lbm_uint symlist);
 
lbm_uint *lbm_image_add_and_link_symbol(char *name, lbm_uint id, lbm_uint symlist, lbm_uint *link);
 
// startup initialization
void lbm_image_init(uint32_t *image_mem_addr,
                    uint32_t  image_size,
                    lbm_image_write_fun  image_write_fun);
 
void lbm_image_create(char *version_str);
 
bool lbm_image_exists(void);
 
bool lbm_image_boot(void);
 
char *lbm_image_get_version(void);
 
#endif