resource_manager.h File Reference

Embedded resource management. More...

#include "compiler_port.h"
#include "error.h"

Go to the source code of this file.

Data Structures

struct  DirEntry
 

Typedefs

struct {
   char_t   type
 
   uint32_t   dataStart
 
   uint32_t   dataLength
 
   uint8_t   nameLength
 
   char_t   name []
 
ResEntry
 Resource entry. More...
 
struct {
   char_t   type
 
   uint32_t   dataStart
 
   uint32_t   dataLength
 
   uint8_t   nameLength
 
ResRootEntry
 Root entry. More...
 
struct {
   uint32_t   totalSize
 
   ResRootEntry   rootEntry
 
ResHeader
 Resource header. More...
 

Enumerations

enum  ResType { RES_TYPE_DIR = 1, RES_TYPE_FILE = 2 }
 Resource type. More...
 

Functions

error_t resGetData (const char_t *path, uint8_t **data, size_t *length)
 
error_t resSearchFile (const char_t *path, DirEntry *dirEntry)
 

Detailed Description

Embedded resource management.

License

Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.

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 2 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, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
1.9.0

Definition in file resource_manager.h.

Typedef Documentation

◆ ResEntry

typedef { ... } ResEntry

Resource entry.

◆ ResHeader

typedef { ... } ResHeader

Resource header.

◆ ResRootEntry

typedef { ... } ResRootEntry

Root entry.

Enumeration Type Documentation

◆ ResType

enum ResType

Resource type.

Enumerator
RES_TYPE_DIR 
RES_TYPE_FILE 

Definition at line 44 of file resource_manager.h.

Function Documentation

◆ resGetData()

error_t resGetData ( const char_t path,
uint8_t **  data,
size_t *  length 
)

Definition at line 37 of file resource_manager.c.

◆ resSearchFile()

error_t resSearchFile ( const char_t path,
DirEntry dirEntry 
)

Definition at line 133 of file resource_manager.c.

Variable Documentation

◆ dataLength

uint32_t dataLength

Definition at line 65 of file resource_manager.h.

◆ dataStart

uint32_t dataStart

Definition at line 64 of file resource_manager.h.

◆ name

char_t name[]

Definition at line 67 of file resource_manager.h.

◆ nameLength

uint8_t nameLength

Definition at line 66 of file resource_manager.h.

◆ rootEntry

ResRootEntry rootEntry

Definition at line 91 of file resource_manager.h.

◆ totalSize

uint32_t totalSize

Definition at line 90 of file resource_manager.h.

◆ type

char_t type

Definition at line 63 of file resource_manager.h.