Return to aav.h CVS log

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

Annotation of libelwix/inc/elwix/aav.h, revision 1.2

1.2     ! misho       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.1.2.1 2013/02/04 16:42:18 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, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
        !            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: 
        !            50: /*
        !            51:  * av_Path2File() - Parse and make path/filename pair
        !            52:  *
        !            53:  * @csArgs = Input argument line
        !            54:  * @psPath = Output Path, if ==NULL path not returned
        !            55:  * @pathLen = Size of path array
        !            56:  * @psFile = Output File
        !            57:  * @fileLen = Size of file array
        !            58:  * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
        !            59:  */
        !            60: int av_Path2File(const char * __restrict csArgs, char * __restrict psPath, 
        !            61:                int pathLen, char * __restrict psFile, int fileLen);
        !            62: 
        !            63: /*
        !            64:  * av_Make() - Parse and make attribute/value pair
        !            65:  *
        !            66:  * @csArgs = Input argument line
        !            67:  * @csDelim = Delimiter for separate
        !            68:  * @psAttr = Output Attribute
        !            69:  * @attrLen = Size of attribute array
        !            70:  * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
        !            71:  * @valLen = Size of value array
        !            72:  * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
        !            73: */
        !            74: int av_Make(const char * __restrict csArgs, const char *csDelim, 
        !            75:                char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);
        !            76: /*
        !            77:  * av_MakeExt() - Parse and make attribute/value pair over input string
        !            78:  *
        !            79:  * @csArgs = Input argument line, will be modified!
        !            80:  * @csDelim = Delimiter for separate
        !            81:  * @psAttr = Output Attribute
        !            82:  * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
        !            83:  * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
        !            84: */
        !            85: int av_MakeExt(char * __restrict psArgs, const char *csDelim, 
        !            86:                char ** __restrict psAttr, char ** __restrict psValue);
        !            87: /*
        !            88:  * av_Save() - Attribute/Value pair store to file
        !            89:  *
        !            90:  * @csPath = Directory
        !            91:  * @csAttr = Attribute
        !            92:  * @csVal = Value
        !            93:  * @update = Update if a/v exists
        !            94:  * @perm = File permissions, if =0 set default perm=0600
        !            95:  * return: -1 error or >-1 written bytes
        !            96:  */
        !            97: int av_Save(const char *csPath, const char *csAttr, const char *csVal, int update, int perm);
        !            98: /*
        !            99:  * av_Load() - Get stored Attribute/Value
        !           100:  *
        !           101:  * @csPath = Directory
        !           102:  * @csAttr = Attribute
        !           103:  * @psVal = Value
        !           104:  * @valLen = Value length
        !           105:  * @del = Delete a/v pair after read
        !           106:  * return: -1 error or >-1 readed bytes
        !           107:  */
        !           108: int av_Load(const char *csPath, const char *csAttr, char *psVal, int valLen, int del);
        !           109: 
        !           110: 
        !           111: #endif