Oyranos Color Management System API
Functions
oyranos_core.c File Reference

public Oyranos API's More...

#include "oyranos_core.h"
#include <sys/stat.h>
#include <stdarg.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "oyranos_config_internal.h"
#include "oyranos_debug.h"
#include "oyranos_helper.h"
#include "oyranos_internal.h"
#include "oyranos_icc.h"
#include "oyranos_io.h"
#include "oyranos_sentinel.h"
#include "oyranos_string.h"
#include "oyranos_texts.h"
#include "oyStruct_s.h"
#include "oyObject_s_.h"
#include "oyName_s_.h"
#include "config.log.h"

Functions

int oyStruct_RegisterStaticMessageFunc (int type, oyStruct_RegisterStaticMessageFunc_f f)
 register a function for verbosity More...
 
const char * oyStruct_GetInfo (oyPointer context_object, int flags)
 get a additional string from a object More...
 
const char * oyStructTypeToText (oyOBJECT_e type)
 Objects type to small string. More...
 
int oyMessageFormat (char **message_text, int code, const oyPointer context_object, const char *string)
 default function to form a message string More...
 
int oyMessageFunc (int code, const oyPointer context_object, const char *format,...)
 default message function to console More...
 
int oyMessageFuncSet (oyMessage_f message_func)
 
const char * oyLanguage (void)
 get language code More...
 
const char * oyCountry (void)
 get country code More...
 
const char * oyLang (void)
 get LANG code/variable More...
 
void oyI18Nreset (void)
 reset i18n language and country variables More...
 
int oyVersion (int type)
 give the compiled in library version More...
 
char * oyVersionString (int type, oyAlloc_f allocateFunc)
 give the configure options for Oyranos More...
 
icUInt16Number oyValueUInt16 (icUInt16Number val)
 convert to network byte order on little endian machines More...
 
icUInt32Number oyValueUInt32 (icUInt32Number val)
 convert to network byte order More...
 
icS15Fixed16Number oyValueInt32 (icS15Fixed16Number val)
 convert to network byte order More...
 
unsigned long oyValueUInt64 (icUInt64Number val)
 convert to network byte order More...
 

Detailed Description

public Oyranos API's

Oyranos is an open source Color Management System

Copyright:
2004-2011 (C) Kai-Uwe Behrmann
Author
Kai-Uwe Behrmann ku.b@.nosp@m.gmx..nosp@m.de
License:
new BSD http://www.opensource.org/licenses/bsd-license.php
Since
2004/11/25

Function Documentation

◆ oyMessageFormat()

int oyMessageFormat ( char **  message_text,
int  code,
const oyPointer  context_object,
const char *  string 
)

default function to form a message string

oyMessageFormat This default message function is used as a message formatter. The resulting string can be placed anywhere, e.g. in a GUI.

See also
the oyMessageFunc() needs just to replace the fprintf with your favourite GUI call.
Version
Oyranos: 0.2.1
Since
2008/04/03 (Oyranos: 0.2.1)
Date
2011/01/15

Referenced by oyMessageFunc().

◆ oyMessageFunc()

int oyMessageFunc ( int  code,
const oyPointer  context_object,
const char *  format,
  ... 
)

default message function to console

oyMessageFunc The default message function is used as a message printer to the console from library start.

Parameters
codea message code understood be your message handler or oyMSG_e
context_objecta oyStruct_s is expected from Oyranos
formatthe text format string for following args
...the variable args fitting to format
Returns
0 - success; 1 - error
Version
Oyranos: 0.3.0
Since
2008/04/03 (Oyranos: 0.1.8)
Date
2009/07/20

References oyMessageFormat().

◆ oyMessageFuncSet()

int oyMessageFuncSet ( oyMessage_f  message_func)

oyMessageFuncSet

Version
Oyranos: 0.1.8
Date
2008/04/03
Since
2008/04/03 (Oyranos: 0.1.8)

◆ oyStruct_GetInfo()

const char* oyStruct_GetInfo ( oyPointer  context_object,
int  flags 
)

get a additional string from a object

oyStruct_GetInfo The content can be provided by object authors by using oyStruct_RegisterStaticMessageFunc() typical at the first time of object creation.

Parameters
[in]context_objectthe object to get informations about
[in]flagscurrently not used
Returns
a string or NULL; The pointer might become invalid after further using the object pointed to by context.
Version
Oyranos: 0.2.1
Since
2011/01/15
Date
2011/01/15

◆ oyStruct_RegisterStaticMessageFunc()

int oyStruct_RegisterStaticMessageFunc ( int  type,
oyStruct_RegisterStaticMessageFunc_f  f 
)

register a function for verbosity

oyStruct_RegisterStaticMessageFunc

Parameters
[in]typethe object oyOBJECT_e type
[in]fthe object string function
Returns
0 - success; >= 1 - error
Version
Oyranos: 0.2.1
Since
2011/01/14
Date
2011/01/14

◆ oyStructTypeToText()

const char* oyStructTypeToText ( oyOBJECT_e  type)

Objects type to small string.

Function oyStructTypeToText Give a basic description of inbuild object types.

Version
Oyranos: 0.5.0
Since
2008/06/24 (Oyranos: 0.1.8)
Date
2012/09/05

Referenced by oyFilterPlug_s::oyFilterPlug_ConnectIntoSocket().