schema_version.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.
*/
 
/*
 * schema_version.h
 *
 *  Created on: 6 May 2016
 *      Author: tyrrells
 */
 
#ifndef SRC_UTIL_INCLUDE_SCHEMA_VERSION_H_
#define SRC_UTIL_INCLUDE_SCHEMA_VERSION_H_
 
#include "grassroots_util_library.h"
#include "typedefs.h"
#include "jansson.h"
 
 
typedef struct SchemaVersion
{
  uint32 sv_major;
 
  uint32 sv_minor;
 
  char *sv_version_s;
} SchemaVersion;
 
 
 
/*
 * 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_SCHEMA_VERSION_TAGS is defined then it will
 * become
 *
 *    const char *ALLOCATE_SCHEMA_VERSION_TAGS = "path";
 *
 * ALLOCATE_SCHEMA_VERSION_TAGS must be defined only once prior to
 * including this header file. Currently this happens in
 * schema_version.c.
 */
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#ifdef ALLOCATE_SCHEMA_VERSION_TAGS
  #define SV_PREFIX GRASSROOTS_UTIL_API
  #define SV_VAL(x) = x
#else
  #define SV_PREFIX extern GRASSROOTS_UTIL_API
  #define SV_VAL(x)
#endif
 
#endif    /* ifndef DOXYGEN_SHOULD_SKIP_THIS */
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
 
SV_PREFIX const uint32 CURRENT_SCHEMA_VERSION_MAJOR SV_VAL(0);
 
 
SV_PREFIX const uint32 CURRENT_SCHEMA_VERSION_MINOR SV_VAL(10);
 
 
GRASSROOTS_UTIL_API SchemaVersion *AllocateSchemaVersion (const int major, const int minor);
 
 
GRASSROOTS_UTIL_API bool SetSchemaVersionDetails (SchemaVersion *sv_p, const int major, const int minor);
 
 
GRASSROOTS_UTIL_API void FreeSchemaVersion (SchemaVersion *sv_p);
 
 
GRASSROOTS_UTIL_API void ClearSchemaVersion (SchemaVersion *sv_p);
 
 
GRASSROOTS_UTIL_API json_t *GetSchemaVersionAsJSON (const SchemaVersion * const sv_p);
 
 
GRASSROOTS_UTIL_API SchemaVersion *GetSchemaVersionFromJSON (const json_t * const json_p);
 
 
 
GRASSROOTS_UTIL_API  SchemaVersion *AllocateCurrentSchemaVersion (void);
 
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* SRC_UTIL_INCLUDE_SCHEMA_VERSION_H_ */