oyranos_core.h File Reference

public Oyranos API's More...

#include <stdarg.h>
#include "oyranos_version.h"
#include "oyranos_types.h"

Enumerations
enum	oyNAME_e { oyNAME_NAME, oyNAME_NICK, oyNAME_DESCRIPTION }
	Information levelMessages consist of text, which contains information depending on the purpose. The information provider obtains with this enum a brief request, what to put into a information request. More...

Functions
int	oyMessageFormat (char **message_text, int code, const void *context, const char *string)
	default function to form a message string More...
int	oyMessageFunc (int code, const void *context_object, const char *format,...)
	default message function to console More...
int	oyMessageFuncSet (oyMessage_f message_func)
int	oyVersion (int type)
	give the compiled in library version More...
const char *	oyVersionString (int type)
	give the configure options for Oyranos More...
void	oyI18NSet (int active, int reserved)
	switch internationalisation of strings on or off More...
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	oyStringAddPrintf (char **text, oyAlloc_f allocateFunc, oyDeAlloc_f deallocFunc, const char *format,...)
	Append a string and handle memory. More...
char **	oyStringSplit (const char *text, const char delimiter, int *count, oyAlloc_f allocateFunc)
	Create a array of strings. More...
void	oyStringListRelease (char ***l, int size, oyDeAlloc_f deallocFunc)
	Release a array of strings. More...
char *	oyStringCopy (const char *text, oyAlloc_f allocateFunc)
	Copy with allocator. More...

Variables
int	oy_debug
	Set debug level. More...
int	oy_debug_objects
	Activate object debugging. More...
const char *	oy_domain_codeset
	codeset for Oyranos 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-3-Clause

Since

2004/11/25

Function Documentation

oyMessageFormat()

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

default function to form a message string

Function 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

oyMessageFunc()

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

default message function to console

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

Parameters

code	a message code understood be your message handler or oyMSG_e
context_object	a oyStruct_s is expected from Oyranos
format	the 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

Examples:

oyranos_cmm_oJPG.c.

oyMessageFuncSet()

int oyMessageFuncSet

(

oyMessage_f

message_func

)

Function oyMessageFuncSet

Version

Oyranos: 0.1.8

Date

2008/04/03

Since

2008/04/03 (Oyranos: 0.1.8)

Variable Documentation

oy_debug

int oy_debug

Set debug level.

Maps to OY_DEBUG environment variable. The usefull value range is 1-20.

See also

Debugging Variables

Version

Oyranos: 0.0.1

Date

2005/02/01

Since

2005/02/01 (Oyranos: 0.0.1)

Examples:

image_display.cpp, and oyranos_cmm_oJPG.c.

Referenced by oyFilterPlug_ImageRootRun(), oyObject_UnRef(), oyPixelAccess_s::oyPixelAccess_SynchroniseROI(), and oyPointer_s::oyPointer_LookUpFromObject().

oy_debug_objects

int oy_debug_objects

Activate object debugging.

select object id

Maps to OY_DEBUG_OBJECTS environment variable.

See also

Debugging Variables

Examples:

image_display.cpp.

Referenced by oyObject_GetId(), oyObject_UnRef(), and oyObjectTreePrint().