data_resource.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
#ifndef GRASSROOTS_RESOURCE_H
#define GRASSROOTS_RESOURCE_H
 
#include "jansson.h"
 
#include "grassroots_util_library.h"
#include "typedefs.h"
 
typedef struct DataResource
{
  char *re_protocol_s;
 
  char *re_value_s;
 
  char *re_title_s;
 
  json_t *re_data_p;
} DataResource;
 
/*
 * The following preprocessor macros allow us to declare
 * and define the variables in the same place. By default,
 * they will expand to
 *
 *    extern const char *SERVICE_NAME_S;
 *
 * however if ALLOCATE_JSON_TAGS is defined then it will
 * become
 *
 *    const char *SERVICE_NAME_S = "path";
 *
 * ALLOCATE_RESOURCE_TAGS must be defined only once prior to
 * including this header file. Currently this happens in
 * resource.c.
 */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#ifdef ALLOCATE_DATA_RESOURCE_TAGS
  #define RESOURCE_PREFIX GRASSROOTS_UTIL_API
  #define RESOURCE_VAL(x) = x
#else
  #define RESOURCE_PREFIX extern GRASSROOTS_UTIL_API
  #define RESOURCE_VAL(x)
#endif
 
#endif    /* #ifndef DOXYGEN_SHOULD_SKIP_THIS */
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
 
RESOURCE_PREFIX const char *RESOURCE_DELIMITER_S RESOURCE_VAL("://");
 
RESOURCE_PREFIX const char *PROTOCOL_IRODS_S RESOURCE_VAL("irods");
 
RESOURCE_PREFIX const char *PROTOCOL_FILE_S RESOURCE_VAL("file");
 
RESOURCE_PREFIX const char *PROTOCOL_HTTP_S RESOURCE_VAL("http");
 
RESOURCE_PREFIX const char *PROTOCOL_HTTPS_S RESOURCE_VAL("https");
 
RESOURCE_PREFIX const char* PROTOCOL_INLINE_S RESOURCE_VAL ("inline");
 
 
RESOURCE_PREFIX const char *PROTOCOL_TEXT_S RESOURCE_VAL("text");
 
 
RESOURCE_PREFIX const char *PROTOCOL_SERVICE_S RESOURCE_VAL("service");
 
 
 
 
GRASSROOTS_UTIL_API DataResource *AllocateDataResource (const char *protocol_s, const char *value_s, const char *title_s);
 
 
GRASSROOTS_UTIL_API void InitDataResource (DataResource *resource_p);
 
 
GRASSROOTS_UTIL_API void FreeDataResource (DataResource *resource_p);
 
 
GRASSROOTS_UTIL_API void ClearDataResource (DataResource *resource_p);
 
 
GRASSROOTS_UTIL_API bool SetDataResourceValue (DataResource *resource_p, const char *protocol_s, const char *value_s, const char *title_s);
 
 
GRASSROOTS_UTIL_API bool SetDataResourceData (DataResource *resource_p, json_t *data_p, const bool owns_data_flag);
 
 
GRASSROOTS_UTIL_API bool CopyDataResource (const DataResource * const src_p, DataResource * const dest_p);
 
 
GRASSROOTS_UTIL_API DataResource *CloneDataResource (const DataResource * const src_p);
 
 
GRASSROOTS_UTIL_API DataResource *ParseStringToDataResource (const char * const resource_s);
 
 
GRASSROOTS_UTIL_API bool GetDataResourceProtocolAndPath (const char * const resource_s, char ** const path_ss, char ** const protocol_ss);
 
 
GRASSROOTS_UTIL_API json_t *GetDataResourceAsJSONByParts (const char * const protocol_s, const char * const path_s, const char * const title_s, json_t *data_p);
 
 
GRASSROOTS_UTIL_API json_t *GetDataResourceAsJSON (const DataResource *resource_p);
 
 
GRASSROOTS_UTIL_API DataResource *GetDataResourceFromJSON (const json_t *json_p);
 
 
#ifdef __cplusplus
}
#endif
 
 
 
#endif    /* #ifndef GRASSROOTS_RESOURCE_H */