KEPath.h File Reference

Define KEPath class. More...

#include <Coconut/Coconut.h>
#include "KEObject.h"
#include "KEForwarders.h"

Go to the source code of this file.

Data Structures
struct	KEPath

Functions
struct KEPath *	KEAllocatePath (struct KELineInfo *linfo, struct CNResource *resource)
	Alloxate KEPath object. More...
CNBoolean	KEAddIdentifiersToPathWithString (struct KEPath *dst, struct CNString *pathstr)
	Add multiple identities by the string which contains identifiers and commas. More...
struct KEPath *	KEAllocateTailPathInPath (struct KEPath *src)
	Allocate path by source path without 1st item. More...
struct CNString *	KEPathToString (const struct KEPath *path, struct CNResource *resource)
	Encode path to string. More...
void	KEDumpPath (struct CNText *outbuf, const struct KEPath *src)
	Dump context of the path. More...
void	KEPrintPath (FILE *outfp, const struct KEPath *src)
	Print context of the path. More...

Detailed Description

Define KEPath class.

Copyright

Copyright (C) 2013 Steel Wheels Project

Function Documentation

CNBoolean KEAddIdentifiersToPathWithString	(	struct KEPath *	dst,
		struct CNString *	pathstr
	)

Add multiple identities by the string which contains identifiers and commas.

Return values

CNTrue	Successed
CNFalse	Failed because the source string is not correct

Parameters

dst	Destination path
pathstr	String which contains identifiers and commas

struct KEPath* KEAllocatePath	(	struct KELineInfo *	linfo,
		struct CNResource *	resource
	)

Alloxate KEPath object.

Returns

Allocated object

Parameters

linfo	Line information of the path
resource	Resource to allocate the object

struct KEPath* KEAllocateTailPathInPath

(

struct KEPath *

src

)

Allocate path by source path without 1st item.

Returns

Allocated path

Parameters

src	Source path

Warning

The source path MUST HAVE 2 or more identifiers

void KEDumpPath	(	struct CNText *	outbuf,
		const struct KEPath *	src
	)

Dump context of the path.

Parameters

outbuf	Output buffer
src	Source path

struct CNString* KEPathToString	(	const struct KEPath *	path,
		struct CNResource *	resource
	)

Encode path to string.

Returns

Encoded string

Parameters

path	Source path
resource	Resource to allocate the string

void KEPrintPath	(	FILE *	outfp,
		const struct KEPath *	src
	)

Print context of the path.

Parameters

outfp	Output file stream
src	Source path