sanei/sanei__config_8h_source.html

/* sane - Scanner Access Now Easy.

   Copyright (C) 1997 Jeffrey S. Freedman

   This file is part of the SANE package.


   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, see <https://www.gnu.org/licenses/>.


   As a special exception, the authors of SANE give permission for

   additional uses of the libraries contained in this release of SANE.


   The exception is that, if you link a SANE library with other files

   to produce an executable, this does not by itself cause the

   resulting executable to be covered by the GNU General Public

   License.  Your use of that executable is in no way restricted on

   account of linking the SANE library code into it.


   This exception does not, however, invalidate any other reasons why

   the executable file might be covered by the GNU General Public

   License.


   If you submit changes to SANE to the maintainers to be included in

   a subsequent release, you agree by submitting the changes that

   those changes may be distributed with this exception intact.


   If you write modifications of your own for SANE, it is your choice

   whether to permit this exception to apply to your modifications.

   If you do not wish that, delete this exception notice.

*/


#ifndef sanei_config_h

#define sanei_config_h 1


#include <stdio.h>

#include <sane/sane.h>


#ifdef __cplusplus

extern "C" {

#endif


extern FILE *sanei_config_open (const char *name);


extern char *sanei_config_read (char *str, int n, FILE *stream);


extern const char *sanei_config_skip_whitespace (const char *str);


extern const char *sanei_config_get_string (const char *str,

                                            char **string_const);


extern void sanei_config_attach_matching_devices (const char *name,

                                                  SANE_Status (*attach)

                                                  (const char *dev));


typedef struct

{

  SANE_Int count;


  SANE_Option_Descriptor **descriptors;


  void **values;


} SANEI_Config;


extern SANE_Status sanei_configure_attach (

  const char *config_file,

  SANEI_Config *config,

  SANE_Status (*config_attach)(SANEI_Config *config, const char *devname,

                               void *data),

  void *data

);


extern const char *sanei_config_get_paths (void);


#ifdef __cplusplus

} // extern "C"

#endif


#endif  /* sanei_config_h */

sanei_configure_attach
SANE_Status sanei_configure_attach(const char *config_file, SANEI_Config *config, SANE_Status(*config_attach)(SANEI_Config *config, const char *devname, void *data), void *data)
Parse configuration file, reading configuration options and trying to attach devices found in file.

sanei_config_get_string
const char * sanei_config_get_string(const char *str, char **string_const)
Scan a string constant from a line of text and return a malloced copy of it.

sanei_config_attach_matching_devices
void sanei_config_attach_matching_devices(const char *name, SANE_Status(*attach)(const char *dev))
Expand device name patterns into a list of devices.

sanei_config_read
char * sanei_config_read(char *str, int n, FILE *stream)
Read a line from configuration file.

sanei_config_open
FILE * sanei_config_open(const char *name)
Search configuration file name along directory list and return file pointer if such a file exists.

sanei_config_get_paths
const char * sanei_config_get_paths(void)
Return the list of config directories, extracted from the SANE_CONFIG_DIR environment variable and th...

sanei_config_skip_whitespace
const char * sanei_config_skip_whitespace(const char *str)
Remove all whitespace from the beginning of a string.

SANEI_Config
this structure holds the description of configuration options.
Definition: sanei_config.h:137

SANEI_Config::values
void ** values
values for the configuration options
Definition: sanei_config.h:145

SANEI_Config::count
SANE_Int count
number of options
Definition: sanei_config.h:139

SANEI_Config::descriptors
SANE_Option_Descriptor ** descriptors
NULL terminated list of configuration option.
Definition: sanei_config.h:142