libgphoto2 photo camera library (libgphoto2) API  2.4.11
gphoto2-list.c File Reference
#include "config.h"
#include <gphoto2/gphoto2-list.h>
#include <gphoto2/gphoto2-port-log.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <gphoto2/gphoto2-result.h>

Data Structures

struct  _CameraList
 

Macros

#define CHECK_NULL(r)   {if (!(r)) return (GP_ERROR_BAD_PARAMETERS);}
 
#define CHECK_RESULT(result)   {int r = (result); if (r < 0) return (r);}
 
#define CHECK_LIST(list)
 
#define CAMERALIST_STRUCT_COMPATIBILITY
 
#define MAX_ENTRIES   1024
 
#define MAX_LIST_STRING_LENGTH   128
 
#define CHECK_INDEX_RANGE(list, index)
 

Functions

int gp_list_new (CameraList **list)
 Creates a new CameraList. More...
 
int gp_list_ref (CameraList *list)
 Increments the reference count of the list. More...
 
int gp_list_unref (CameraList *list)
 Decrements the reference count of the list. More...
 
int gp_list_free (CameraList *list)
 
int gp_list_reset (CameraList *list)
 
int gp_list_append (CameraList *list, const char *name, const char *value)
 
int gp_list_sort (CameraList *list)
 
int gp_list_count (CameraList *list)
 
int gp_list_find_by_name (CameraList *list, int *index, const char *name)
 
int gp_list_get_name (CameraList *list, int index, const char **name)
 
int gp_list_get_value (CameraList *list, int index, const char **value)
 
int gp_list_set_value (CameraList *list, int index, const char *value)
 
int gp_list_set_name (CameraList *list, int index, const char *name)
 
int gp_list_populate (CameraList *list, const char *format, int count)
 

Detailed Description

Author
Copyright 2000 Scott Fritzinger
Note
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This library 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 Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Macro Definition Documentation

#define CAMERALIST_STRUCT_COMPATIBILITY

Whether to preserve binary compatibility for structure internals.

Question: Find out whether any libgphoto2 frontend relies on those internals. Answer: They do, at least by instantiation a "struct CameraList foo;".

Binary compatibility and problems:

  • fixed string size for name and value
  • fixed max number of entries
  • some apps instantiate a "struct CameraList foo;" directly and thus reserve a specific amount of memory
  • FIXME: Do frontends rely on the memory layout and size of their "struct CameraList" or "struct CameraList *" when accessing its members? They SHOULD use access functions.
#define CHECK_INDEX_RANGE (   list,
  index 
)
Value:
do { \
if (index < 0 || index >= list->count) { \
} \
} while (0)
#define GP_ERROR_BAD_PARAMETERS
Bad parameters passed.
Definition: gphoto2-port-result.h:38
#define CHECK_LIST (   list)
Value:
do { \
if (NULL == list) { \
} else if (list->ref_count == 0) { \
/* catch calls to already freed list */ \
} \
} while (0)
#define GP_ERROR_BAD_PARAMETERS
Bad parameters passed.
Definition: gphoto2-port-result.h:38

check that the list is valid

Referenced by gp_list_append(), gp_list_count(), gp_list_find_by_name(), gp_list_free(), gp_list_get_name(), gp_list_get_value(), gp_list_populate(), gp_list_ref(), gp_list_reset(), gp_list_set_name(), gp_list_set_value(), gp_list_sort(), and gp_list_unref().

#define MAX_ENTRIES   1024

Internal _CameraList data structure

Referenced by gp_list_append().

Function Documentation

int gp_list_append ( CameraList list,
const char *  name,
const char *  value 
)

Appends name and value to the list.

Parameters
lista CameraList
namethe name of the entry to append
valuethe value of the entry to append
Returns
a gphoto2 error code

References CHECK_LIST, GP_ERROR_FIXED_LIMIT_EXCEEDED, gp_log(), GP_LOG_ERROR, GP_OK, and MAX_ENTRIES.

Referenced by gp_abilities_list_detect(), gp_filesystem_list_files(), gp_filesystem_list_folders(), and gp_list_populate().

int gp_list_count ( CameraList list)

Counts the entries in the list.

Parameters
lista CameraList
Returns
a gphoto2 error code

References CHECK_LIST.

Referenced by gp_camera_init(), gp_filesystem_list_files(), and gp_filesystem_list_folders().

int gp_list_find_by_name ( CameraList list,
int *  index,
const char *  name 
)

Retrieves the index of an arbitrary entry with name.

Parameters
lista CameraList
indexpointer to the result index (may be NULL, only set if found)
namename of the entry
Returns
a gphoto2 error code: GP_OK if found.

No guarantees as to the speed of the search, or in what sequence the list is searched.

References CHECK_LIST, GP_ERROR, and GP_OK.

int gp_list_free ( CameraList list)

Frees the list. It is recommended to use gp_list_unref instead.

Parameters
listthe CameraList to be freed
Returns
a gphoto2 error code

References CHECK_LIST, and GP_OK.

Referenced by gp_camera_init(), gp_filesystem_number(), gp_filesystem_remove_dir(), and gp_list_unref().

int gp_list_get_name ( CameraList list,
int  index,
const char **  name 
)

Retrieves the name of entry with index.

Parameters
lista CameraList
indexindex of the entry
name
Returns
a gphoto2 error code.

References CHECK_LIST, and GP_OK.

Referenced by gp_camera_init(), gp_filesystem_list_files(), and gp_filesystem_list_folders().

int gp_list_get_value ( CameraList list,
int  index,
const char **  value 
)

Retrieves the value of entry with index.

Parameters
lista CameraList
indexindex of the entry
value
Returns
a gphoto2 error code

References CHECK_LIST, and GP_OK.

Referenced by gp_camera_init().

int gp_list_new ( CameraList **  list)

Creates a new CameraList.

Parameters
list
Returns
a gphoto2 error code

References GP_ERROR_NO_MEMORY, and GP_OK.

Referenced by gp_camera_init(), gp_filesystem_number(), and gp_filesystem_remove_dir().

int gp_list_populate ( CameraList list,
const char *  format,
int  count 
)

Adds count entries to the list.

Parameters
lista CameraList
formatthe format
countnumber of entries to be added to the list return a gphoto2 error code

Typically, this function is called by a camera driver when there is no way of retrieving the real name of a picture. In this case, when asked for a file list (see #CameraFilesystemListFunc), the list is populated with dummy names generated by this function.

References CHECK_LIST, gp_list_append(), gp_list_reset(), and GP_OK.

int gp_list_ref ( CameraList list)

Increments the reference count of the list.

Parameters
lista CameraList
Returns
a gphoto2 error code.

References CHECK_LIST, and GP_OK.

int gp_list_reset ( CameraList list)

Resets the list and removes all entries.

Parameters
lista CameraList
Returns
a gphoto2 error code

References CHECK_LIST, and GP_OK.

Referenced by gp_abilities_list_detect(), gp_camera_folder_list_files(), gp_camera_folder_list_folders(), gp_filesystem_list_files(), gp_filesystem_list_folders(), and gp_list_populate().

int gp_list_set_name ( CameraList list,
int  index,
const char *  name 
)

Sets the name of an entry.

Parameters
lista CameraList
indexindex of entry
namename to be set
Returns
a gphoto2 error code

References CHECK_LIST, GP_ERROR_FIXED_LIMIT_EXCEEDED, gp_log(), GP_LOG_ERROR, and GP_OK.

int gp_list_set_value ( CameraList list,
int  index,
const char *  value 
)

Sets the value of an entry.

Parameters
lista CameraList
indexindex of the entry
valuethe value to be set
Returns
a gphoto2 error code

References CHECK_LIST, GP_ERROR_FIXED_LIMIT_EXCEEDED, gp_log(), GP_LOG_ERROR, and GP_OK.

int gp_list_sort ( CameraList list)

Sorts the list entries with respect to the names.

Parameters
lista CameraList
Returns
a gphoto2 error code

References CHECK_LIST, and GP_OK.

Referenced by gp_camera_folder_list_files(), and gp_camera_folder_list_folders().

int gp_list_unref ( CameraList list)

Decrements the reference count of the list.

Parameters
lista CameraList
Returns
a gphoto2 error code

If there are no references left, the list will be freed.

References CHECK_LIST, gp_list_free(), and GP_OK.