102 lines
3.2 KiB
C
102 lines
3.2 KiB
C
|
/*
|
||
|
|
* Copyright (C) 2018 Muhammad Tayyab Akram
|
||
|
|
*
|
||
|
|
* 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 _SB_PUBLIC_SCRIPT_LOCATOR_H
|
||
|
|
#define _SB_PUBLIC_SCRIPT_LOCATOR_H
|
||
|
|
|
||
|
|
#include "SBBase.h"
|
||
|
|
#include "SBCodepointSequence.h"
|
||
|
|
#include "SBScript.h"
|
||
|
|
|
||
|
|
typedef struct _SBScriptLocator *SBScriptLocatorRef;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* A structure containing the information about a run of code points having same script.
|
||
|
|
*/
|
||
|
|
typedef struct _SBScriptAgent {
|
||
|
|
SBUInteger offset; /**< The index to the first code unit of the run in source string. */
|
||
|
|
SBUInteger length; /**< The number of code units covering the length of the run. */
|
||
|
|
SBScript script; /**< The script of the run. */
|
||
|
|
} SBScriptAgent;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates a script locator object which can be used to find script runs in a string.
|
||
|
|
*
|
||
|
|
* @return
|
||
|
|
* A reference to a script locator object.
|
||
|
|
*/
|
||
|
|
SBScriptLocatorRef SBScriptLocatorCreate(void);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Loads a code point sequence in the locator so that its script runs can be located.
|
||
|
|
*
|
||
|
|
* @param locator
|
||
|
|
* The locator in which the code point sequence will be loaded.
|
||
|
|
* @param codepointSequence
|
||
|
|
* The code point sequence which will be loaded in the locator.
|
||
|
|
*/
|
||
|
|
void SBScriptLocatorLoadCodepoints(SBScriptLocatorRef locator, const SBCodepointSequence *codepointSequence);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the agent containing the information of current located script run.
|
||
|
|
*
|
||
|
|
* @param locator
|
||
|
|
* The locator whose agent is returned.
|
||
|
|
*/
|
||
|
|
const SBScriptAgent *SBScriptLocatorGetAgent(SBScriptLocatorRef locator);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Instructs the locator to find next script run in the loaded code point sequence.
|
||
|
|
*
|
||
|
|
* @param locator
|
||
|
|
* The locator whom you want to instruct.
|
||
|
|
* @return
|
||
|
|
* SBTrue if another script run is available, SBFalse otherwise.
|
||
|
|
* @note
|
||
|
|
* The locator will be reset after locating last script run.
|
||
|
|
*/
|
||
|
|
SBBoolean SBScriptLocatorMoveNext(SBScriptLocatorRef locator);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Instructs the locator to reset itself so that script runs of the loaded line can be obatained
|
||
|
|
* from the beginning.
|
||
|
|
*
|
||
|
|
* @param locator
|
||
|
|
* The locator whom you want to reset.
|
||
|
|
*/
|
||
|
|
void SBScriptLocatorReset(SBScriptLocatorRef locator);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Increments the reference count of a script locator object.
|
||
|
|
*
|
||
|
|
* @param locator
|
||
|
|
* The script locator object whose reference count will be incremented.
|
||
|
|
* @return
|
||
|
|
* The same script locator object passed in as the parameter.
|
||
|
|
*/
|
||
|
|
SBScriptLocatorRef SBScriptLocatorRetain(SBScriptLocatorRef locator);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Decrements the reference count of a script locator object. The object will be deallocated when
|
||
|
|
* its reference count reaches zero.
|
||
|
|
*
|
||
|
|
* @param locator
|
||
|
|
* The script locator object whose reference count will be decremented.
|
||
|
|
*/
|
||
|
|
void SBScriptLocatorRelease(SBScriptLocatorRef locator);
|
||
|
|
|
||
|
|
#endif
|