Return to aav.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / libelwix / inc / elwix

Version 6.7

    1: /*************************************************************************
    2: * (C) 2013 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
    3: *  by Michael Pounov <misho@elwix.org>
    4: *
    5: * $Author: misho $
    6: * $Id: aav.h,v 1.5 2025/08/21 15:43:00 misho Exp $
    7: *
    8: **************************************************************************
    9: The ELWIX and AITNET software is distributed under the following
   10: terms:
   11: 
   12: All of the documentation and software included in the ELWIX and AITNET
   13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
   14: 
   15: Copyright 2004 - 2024
   16: 	by Michael Pounov <misho@elwix.org>.  All rights reserved.
   17: 
   18: Redistribution and use in source and binary forms, with or without
   19: modification, are permitted provided that the following conditions
   20: are met:
   21: 1. Redistributions of source code must retain the above copyright
   22:    notice, this list of conditions and the following disclaimer.
   23: 2. Redistributions in binary form must reproduce the above copyright
   24:    notice, this list of conditions and the following disclaimer in the
   25:    documentation and/or other materials provided with the distribution.
   26: 3. All advertising materials mentioning features or use of this software
   27:    must display the following acknowledgement:
   28: This product includes software developed by Michael Pounov <misho@elwix.org>
   29: ELWIX - Embedded LightWeight unIX and its contributors.
   30: 4. Neither the name of AITNET nor the names of its contributors
   31:    may be used to endorse or promote products derived from this software
   32:    without specific prior written permission.
   33: 
   34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
   35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   37: ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   44: SUCH DAMAGE.
   45: */
   46: #ifndef __AV_H
   47: #define __AV_H
   48: 
   49: #ifdef __cplusplus
   50: extern "C" {
   51: #endif
   52: 
   53: /*
   54:  * av_Path2File() - Parse and make path/filename pair
   55:  *
   56:  * @csArgs = Input argument line
   57:  * @psPath = Output Path, if ==NULL path not returned
   58:  * @pathLen = Size of path array
   59:  * @psFile = Output File
   60:  * @fileLen = Size of file array
   61:  * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
   62:  */
   63: int av_Path2File(const char * __restrict csArgs, char * __restrict psPath, 
   64: 		int pathLen, char * __restrict psFile, int fileLen);
   65: 
   66: /*
   67:  * av_Make() - Parse and make attribute/value pair
   68:  *
   69:  * @csArgs = Input argument line
   70:  * @csDelim = Delimiter for separate
   71:  * @psAttr = Output Attribute
   72:  * @attrLen = Size of attribute array
   73:  * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
   74:  * @valLen = Size of value array
   75:  * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
   76: */
   77: int av_Make(const char * __restrict csArgs, const char *csDelim, 
   78: 		char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);
   79: /*
   80:  * av_MakeExt() - Parse and make attribute/value pair over input string
   81:  *
   82:  * @csArgs = Input argument line, will be modified!
   83:  * @csDelim = Delimiter for separate
   84:  * @psAttr = Output Attribute
   85:  * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
   86:  * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
   87: */
   88: int av_MakeExt(char * __restrict psArgs, const char *csDelim, 
   89: 		char ** __restrict psAttr, char ** __restrict psValue);
   90: /*
   91:  * av_Save() - Attribute/Value pair store to file
   92:  *
   93:  * @csPath = Directory
   94:  * @csAttr = Attribute
   95:  * @csVal = Value
   96:  * @update = Update if a/v exists
   97:  * @perm = File permissions, if =0 set default perm=0600
   98:  * return: -1 error or >-1 written bytes
   99:  */
  100: int av_Save(const char *csPath, const char *csAttr, const char *csVal, int update, int perm);
  101: /*
  102:  * av_Load() - Get stored Attribute/Value
  103:  *
  104:  * @csPath = Directory
  105:  * @csAttr = Attribute
  106:  * @psVal = Value
  107:  * @valLen = Value length
  108:  * @del = Delete a/v pair after read
  109:  * return: -1 error or >-1 readed bytes
  110:  */
  111: int av_Load(const char *csPath, const char *csAttr, char *psVal, int valLen, int del);
  112: 
  113: #ifdef __cplusplus
  114: }
  115: #endif
  116: 
  117: #endif