SimpleFurigana/NSString+Japanese.h at github · shinjukunian/SimpleFurigana · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
//
//  NSString+JapaneseExtras.m
//
//  Created by Grace Steven on 3/26/11.
//  Copyright 2011 works5.com All rights reserved.
//

#import <Foundation/Foundation.h>

#if TARGET_OS_IPHONE
    @import UIKit;
#else
    @import AppKit;
#endif

/*
* Text Type
*/
typedef enum{
    SLGJapaneseStringTypeHiragana,
    SLGJapaneseStringTypeKatakana,
    SLGJapaneseStringTypeKanji,
    SLGJapaneseStringTypeCompound,
    SLGJapaneseStringTypeOther,
}SLGJapaneseStringType;


@interface NSString (NSString_Japanese)


// returns the type of text contained in the string (mixed or just hiragana / katakan / kanji etc)
+(SLGJapaneseStringType)japaneseStringTypeForString:(NSString*)string;

// checks if any of the chars in the string are katakana or hiragana or kanij
+(BOOL)stringContainsJapaneseText:(NSString*)aString;


// transliteration


-(NSString*)stringByTransliteratingJapaneseToRomajiWithWordSeperator:(NSString*)separator;
// calls stringByTransliteratingJapaneseToRomajiWithWordSeperator: with 'nil'
-(NSString*)stringByTransliteratingJapaneseToRomaji;

-(NSString*)stringByTransliteratingJapaneseToHiragana;

-(NSString*)stringByTransliteratingRomajiToKatakana;
-(NSString*)stringByTransliteratingRomajiToHiragana;


// Kanji
-(NSString*)stringByReplacingJapaneseKanjiWithHiragana;

-(NSDictionary*)hiraganaReplacementsForString;

-(NSDictionary*)romajiReplacementsForString;

// very RUDIMENTARY 'sounds like' comparison of two japanese strings
// compares the the reciever to the passed string
// returns a 'score' from 0 to 1 (1 being the most similar to the reciever)
-(CGFloat)phoneticSimilarityToString:(NSString*)targetString;

// pass YES to improve performance by skipping transliteraion
// the reciever and the passed string should already be converted to latinScript
-(CGFloat)phoneticSimilarityToString:(NSString*)string isLatinScript:(BOOL)isLatinScript;


@end