diff --git a/Data/Kanji.hs b/Data/Kanji.hs new file mode 100644 --- /dev/null +++ b/Data/Kanji.hs @@ -0,0 +1,210 @@ +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE ViewPatterns #-} + +-- | +-- Module : Data.Kanji +-- Copyright : (c) Colin Woodbury, 2015 +-- License : GPL3 +-- Maintainer: Colin Woodbury +-- +-- A library for analysing the density of Kanji in given texts, +-- according to their "Level" classification, as defined by the +-- Japan Kanji Aptitude Testing Foundation (日本漢字能力検定協会). + +module Data.Kanji + ( + -- * Kanji + AsKanji(..) + , Kanji(..) + , kanji + , allKanji + , isKanji + , hasLevel + , kanjiDensity + , elementaryKanjiDensity + , percentSpread + -- * Levels + , Level(..) + , Rank + , rankNums + , level + , levels + , isKanjiInLevel + , levelDist + , levelFromRank + , averageLevel + ) where + +import qualified Data.ByteString.Char8 as SB +import qualified Data.ByteString.Lazy.Char8 as LB +import Data.Char (ord) +import Data.List (sort, group) +import qualified Data.Set as S +import Data.String (IsString) +import qualified Data.Text as ST +import qualified Data.Text.Lazy as LT +import Lens.Micro + +import Data.Kanji.TenthQ +import Data.Kanji.NinthQ +import Data.Kanji.EighthQ +import Data.Kanji.SeventhQ +import Data.Kanji.SixthQ +import Data.Kanji.FifthQ +import Data.Kanji.FourthQ +import Data.Kanji.ThirdQ +import Data.Kanji.PreSecondQ +import Data.Kanji.SecondQ + +--- + +-- | All String types can be transformed into a list of Kanji. +class IsString a => AsKanji a where + -- | Transform this string type into a list of Kanji. The source string + -- and the resulting list might not have the same length, if there + -- were `Char` in the source that did not fall within the legal + -- UTF8 range for Kanji. + asKanji :: a -> [Kanji] + +instance AsKanji [Char] where + asKanji cs = cs ^.. traverse . kanji + +instance AsKanji ST.Text where + asKanji = asKanji . ST.unpack + +instance AsKanji LT.Text where + asKanji = asKanji . LT.unpack + +instance AsKanji SB.ByteString where + asKanji = asKanji . SB.unpack + +instance AsKanji LB.ByteString where + asKanji = asKanji . LB.unpack + +-- | A single symbol of Kanji. Japanese Kanji were borrowed from China +-- over several waves during the past millenium. Japan names 2136 of +-- these as their standard set, with rarer characters being the domain +-- of academia and esoteric writers. +-- +-- Japanese has several Japan-only Kanji, including: +-- +-- * 畑 (a type of rice field) +-- * 峠 (a narrow mountain pass) +-- * 働 (to do physical labour) +newtype Kanji = Kanji { _kanji :: Char } deriving (Eq, Ord, Show) + +-- | Traverse into a `Char` to find a `Kanji`. +kanji :: Traversal' Char Kanji +kanji f c = if isKanji c then _kanji <$> f (Kanji c) else pure c + +-- | A Level or "Kyuu" (級) of Japanese Kanji ranking. There are 12 of these, +-- from 10 to 1, including intermediate levels between 3 and 2, and 2 and 1. +-- +-- Japanese students will typically have Level-5 ability by the time they +-- finish elementary school. Level-5 accounts for 1006 characters. +-- +-- By the end of middle school, they would have covered up to Level-3 +-- (1607 Kanji) in their Japanese class curriculum. +-- +-- While Level-2 (2136 Kanji) is considered "standard adult" ability, +-- many adults could not pass the Level-2, or even the Level-Pre2 (1940 Kanji) +-- exam without considerable study. +-- +-- Level data for Kanji above Level-2 is currently not provided by +-- this library. +data Level = Level { _allKanji :: S.Set Kanji + , _rank :: Rank + } deriving (Eq, Show) + +-- | A numeric representation of a `Level`. +type Rank = Float + +-- | Numerical representations of the 12 ranks. +rankNums :: [Rank] +rankNums = [10,9,8,7,6,5,4,3,2.5,2,1.5,1] + +-- | All Kanji, grouped by their Level (級) in ascending order. +-- Here, ascending order means from the lowest to the highest level, +-- meaning from 10 to 1. +allKanji :: [[Kanji]] +allKanji = map asKanji ks + where ks = [tenthQ, ninthQ, eighthQ, seventhQ, sixthQ, + fifthQ, fourthQ, thirdQ, preSecondQ, secondQ] + +-- | Legal Kanji appear between UTF8 characters 19968 and 40959. +isKanji :: Char -> Bool +isKanji c = lowLimit <= c' && c' <= highLimit + where c' = ord c + lowLimit = 19968 -- This is `一` + highLimit = 40959 -- I don't have the right fonts to display this. + +-- | Is the `Level` of a given `Kanji` known? +hasLevel :: [Level] -> Kanji -> Bool +hasLevel qs k = has _Just $ level qs k + +-- | What is the density @d@ of Kanji characters in a given String, +-- where @0 <= d <= 1@? +kanjiDensity :: [Char] -> Float +kanjiDensity ks = length' (asKanji ks) / length' ks + where length' = fromIntegral . length + +-- | As above, but only Kanji of the first 1006 are counted (those learned +-- in elementary school in Japan). +elementaryKanjiDensity :: [Char] -> Float +elementaryKanjiDensity ks = foldl (\acc (_,p) -> acc + p) 0 elementaryQs + where elementaryQs = filter (\(qn,_) -> qn `elem` [5..10]) distributions + distributions = levelDist levels $ asKanji ks + +makeLevel :: [Kanji] -> Rank -> Level +makeLevel ks n = Level (S.fromDistinctAscList ks) n + +-- | All `Level`s, with all their `Kanji`, ordered from Level-10 to Level-2. +levels :: [Level] +levels = map f $ zip allKanji rankNums + where f (ks,n) = makeLevel ks n + +-- | What `Level` does a Kanji belong to? +level :: [Level] -> Kanji -> Maybe Level +level [] _ = Nothing +level (q:qs) k | isKanjiInLevel q k = Just q + | otherwise = level qs k + +-- | Does a given `Kanji` belong to the given `Level`? +isKanjiInLevel :: Level -> Kanji -> Bool +isKanjiInLevel q k = S.member k $ _allKanji q + +-- | Some Kanji may be outside the Level system. This means they are +-- particularly difficult, and are given a rank of 0 here. +-- This is used internally for averaging calculations. +rank :: [Level] -> Kanji -> Rank +rank qs k = maybe 0 _rank $ level qs k + +-- | Is there a `Level` that corresponds with a given `Rank` value? +levelFromRank :: [Level] -> Rank -> Maybe Level +levelFromRank [] _ = Nothing +levelFromRank (q:qs) qn | _rank q == qn = Just q + | otherwise = levelFromRank qs qn + +-- | Find the average `Level` of a given set of `Kanji`. +averageLevel :: [Level] -> [Kanji] -> Float +averageLevel qs ks = average $ map (rank qs) ks + where average ns = (sum ns) / (fromIntegral $ length ns) + +-- | How much of each `Level` is represented by a group of Kanji? +levelDist :: [Level] -> [Kanji] -> [(Rank,Float)] +levelDist qs ks = map toNumPercentPair $ group sortedRanks + where sortedRanks = sort $ map (rank qs) ks + toNumPercentPair qns = (head qns, length' qns / length' sortedRanks) + length' n = fromIntegral $ length n + +-- | The distribution of each `Kanji` in a set of them. +-- The distribution values must sum to 1. +percentSpread :: [Kanji] -> [(Kanji,Float)] +percentSpread ks = map getPercent kQuants + where getPercent (k,q) = (k, fromIntegral q / totalKanji) + kQuants = kanjiQuantities ks + totalKanji = fromIntegral $ foldl (\acc (_,q) -> q + acc) 0 kQuants + +-- | Determines how many times each `Kanji` appears in given set of them. +kanjiQuantities :: [Kanji] -> [(Kanji,Int)] +kanjiQuantities = map (\ks -> (head ks, length ks)) . group . sort diff --git a/Data/Kanji/EighthQ.hs b/Data/Kanji/EighthQ.hs new file mode 100644 --- /dev/null +++ b/Data/Kanji/EighthQ.hs @@ -0,0 +1,15 @@ +module Data.Kanji.EighthQ where + +-- | The Kanji unique to Level-8, studied by the end of 3rd grade in +-- Japanese elementary schools. +eighthQ :: [Char] +eighthQ = "丁世両主乗予事仕他代住使係倍全具写列助勉" ++ + "動勝化区医去反取受号向君味命和品員商問坂" ++ + "央始委守安定実客宮宿寒対局屋岸島州帳平幸" ++ + "度庫庭式役待急息悪悲想意感所打投拾持指放" ++ + "整旅族昔昭暑暗曲有服期板柱根植業様横橋次" ++ + "歯死氷決油波注泳洋流消深温港湖湯漢炭物球" ++ + "由申界畑病発登皮皿相県真着短研礼神祭福秒" ++ + "究章童笛第筆等箱級終緑練羊美習者育苦荷落" ++ + "葉薬血表詩調談豆負起路身転軽農返追送速進" ++ + "遊運部都配酒重鉄銀開院陽階集面題飲館駅鼻" diff --git a/Data/Kanji/FifthQ.hs b/Data/Kanji/FifthQ.hs new file mode 100644 --- /dev/null +++ b/Data/Kanji/FifthQ.hs @@ -0,0 +1,15 @@ +module Data.Kanji.FifthQ where + +-- | The Kanji unique to Level-5, studied by the end of 6th grade in +-- Japanese elementary schools. +fifthQ :: [Char] +fifthQ = "並乱乳亡仁供俳値傷優党冊処刻割創劇勤危卵" ++ + "厳収后否吸呼善困垂城域奏奮姿存孝宅宇宗宙" ++ + "宝宣密寸専射将尊就尺届展層己巻幕干幼庁座" ++ + "延律従忘忠憲我批担拝拡捨探推揮操敬映晩暖" ++ + "暮朗机枚染株棒模権樹欲段沿泉洗派済源潮激" ++ + "灰熟片班異疑痛皇盛盟看砂磁私秘穀穴窓筋策" ++ + "簡糖系紅納純絹縦縮署翌聖肺背胸脳腹臓臨至" ++ + "若著蒸蔵蚕衆裁装裏補視覧討訪訳詞誌認誕誠" ++ + "誤論諸警貴賃遺郵郷針鋼閉閣降陛除障難革頂" ++ + "骨" diff --git a/Data/Kanji/FourthQ.hs b/Data/Kanji/FourthQ.hs new file mode 100644 --- /dev/null +++ b/Data/Kanji/FourthQ.hs @@ -0,0 +1,20 @@ +module Data.Kanji.FourthQ where + +-- | The Kanji unique to Level-4, studied during middle school in Japan. +fourthQ :: [Char] +fourthQ = "丈与丘丹乾互井介仰伺依侵俗倒偉傍傾僧儀兼" ++ + "冒凡凶刈到刺剣剤劣勧匹占即却及叫召吐含吹" ++ + "咲唐嘆噴圏坊執堅堤塔壁壊壱奇奥奴妙姓威娘" ++ + "婚寂寝尋尽尾屈峠峰巡巨帽幅幾床弐弾彩影彼" ++ + "征御微徴忙怒怖恋恐恒恥恵悩惑惨慎慢慮憶戒" ++ + "戯扇払扱抗抜抱抵押拍拓拠振捕掘描握援搬摘" ++ + "撃攻敏敷斜旨旬是普暇暦曇更替朱朽杯枯柄柔" ++ + "桃欄歓歳殖殿汗汚沈沖沢沼況泊浜浮浸涙淡添" ++ + "渡溶滴漫澄濁濃為烈煙煮燥爆狂狩狭猛獣獲玄" ++ + "珍環甘畳疲療皆盆盗監盤盾眠瞬矛砲祈秀称稲" ++ + "稿突端箇範粒紋紫紹絡継維網緯縁繁繰罰翼耐" ++ + "肩肪胴脂脚脱腐腕腰膚致舗舞舟般芋芝茂荒菓" ++ + "蓄薄薪被襲触訴詰詳誇誉謡豪販賦贈越趣距跡" ++ + "跳踊踏躍軒較載輝輩込迎迫逃透途遅違遣避郎" ++ + "釈鈍鉛鋭鎖鑑闘陣陰隠隣隷雄雅雌離雷需震霧" ++ + "露響項頼飾香駆騒驚髪鬼鮮麗黙鼓齢" diff --git a/Data/Kanji/NinthQ.hs b/Data/Kanji/NinthQ.hs new file mode 100644 --- /dev/null +++ b/Data/Kanji/NinthQ.hs @@ -0,0 +1,13 @@ +module Data.Kanji.NinthQ where + +-- | The Kanji unique to Level-9, studied by the end of 2nd grade in +-- Japanese elementary schools. +ninthQ :: [Char] +ninthQ = "万丸交京今会体何作元兄光公内冬刀分切前北" ++ + "午半南原友古台合同回図国園地場声売夏外多" ++ + "夜太妹姉室家寺少岩工市帰広店弓引弟弱強当" ++ + "形後心思戸才教数新方明星春昼時晴曜書朝来" ++ + "東楽歌止歩母毎毛池汽活海点父牛理用画番直" ++ + "矢知社秋科答算米紙細組絵線羽考聞肉自船色" ++ + "茶行西親角言計記話語読谷買走近通週道遠里" ++ + "野長門間雪雲電頭顔風食首馬高魚鳥鳴麦黄黒" diff --git a/Data/Kanji/PreSecondQ.hs b/Data/Kanji/PreSecondQ.hs new file mode 100644 --- /dev/null +++ b/Data/Kanji/PreSecondQ.hs @@ -0,0 +1,21 @@ +module Data.Kanji.PreSecondQ where + +-- | The Kanji unique to Level-Pre2, considerend "mid high school" level. +preSecondQ :: [Char] +preSecondQ = "且丙亜享亭仙伯但佐併侮侯俊俸倫偏偵偽傑傘" ++ + "僕僚儒償充准凸凹刃剖剛剰劾勅勲升厄叔叙吟" ++ + "呈呉唆唇唯喝喪嗣嚇囚坪垣培堀堕堪塀塁塑塚" ++ + "塾壌壮奔奨妃妄妊妥姻娠媒嫌嫡宜宰宵寛寡寧" ++ + "寮尉尚尼履屯岬崇崎帥幣庶庸廃廷弊弔弦彰循" ++ + "徹忍恭悠患悼惰愁愉慶憤憾懇懐懲懸戻扉扶抄" ++ + "把披抹拐拒拙括拷挑挟挿捜据搭摩撤撲擬斉斎" ++ + "旋昆暁曹朕朴杉析枠枢柳栓核栽桟棚棟棺槽款" ++ + "殉殻汁江沸泡泥泰洞津洪浄浦涯涼淑渇渉渋渓" ++ + "渦溝滋漆漠漬漸潟濯煩爵猫献猶猿珠琴璽瓶甚" ++ + "畝疎疫症痢痴癒盲眺睡督矯砕硝硫碁磨礁祥禅" ++ + "禍租秩稼窃窮窯竜筒粛粧糾紡索累紳緒縄繊繭" ++ + "缶罷羅翁耗肌肖肢肯臭舶艇艦茎荘菌薦薫藻虜" ++ + "虞蚊蛇蛍融衡衷裕褐褒襟覇訟診詐詔誓諭謁謄" ++ + "謙謹譜貞貢賄賓賜賠購践軟轄迅迭逐逓逝逸遍" ++ + "遮遷還邸酌酢酪酬酷醜醸釣鈴鉢銃銘閑閥附陥" ++ + "隅雰霜靴韻頑頒頻顕飢駄騰麻" diff --git a/Data/Kanji/SecondQ.hs b/Data/Kanji/SecondQ.hs new file mode 100644 --- /dev/null +++ b/Data/Kanji/SecondQ.hs @@ -0,0 +1,14 @@ +module Data.Kanji.SecondQ where + +-- | The Kanji unique to Level-2, considered "standard adult" level. +secondQ :: [Char] +secondQ = "串丼乞亀伎侶俺傲僅冥冶凄刹剥勃勾匂叱呂呪" ++ + "咽哺唄唾喉喩嗅嘲埼堆塞填奈妖妬媛嫉宛尻岡" ++ + "崖嵐巾弄弥彙怨恣惧慄憧憬戚戴拉拭拳拶挨挫" ++ + "捉捗捻摯斑斬旦旺昧曖曽枕柵柿栃桁梗梨椅椎" ++ + "楷毀氾汎汰沃沙淫湧溺潰煎熊爪爽牙狙玩瑠璃" ++ + "璧瓦畏畿痕痩瘍眉睦瞭瞳稽窟箋箸籠綻緻罵羞" ++ + "羨肘股脇脊腎腫腺膝膳臆臼舷艶芯苛茨萎葛蓋" ++ + "蔑蔽藍藤虎虹蜂蜜袖裾訃詣詮誰諦諧謎貌貪貼" ++ + "賂賭踪蹴辣遜遡那酎醒采釜錦錮鍋鍵鎌闇阜阪" ++ + "隙韓頃須頓頬顎餅餌駒骸鬱鶴鹿麓麺" diff --git a/Data/Kanji/SeventhQ.hs b/Data/Kanji/SeventhQ.hs new file mode 100644 --- /dev/null +++ b/Data/Kanji/SeventhQ.hs @@ -0,0 +1,15 @@ +module Data.Kanji.SeventhQ where + +-- | The Kanji unique to Level-7, studied by the end of 4th grade in +-- Japanese elementary schools. +seventhQ :: [Char] +seventhQ = "不争付令以仲伝位低例便信倉候借停健側働億" ++ + "兆児共兵典冷初別利刷副功加努労勇包卒協単" ++ + "博印参史司各告周唱喜器囲固型堂塩士変夫失" ++ + "好季孫完官害察巣差希席帯底府康建径徒得必" ++ + "念愛成戦折挙改救敗散料旗昨景最望未末札材" ++ + "束松果栄案梅械極標機欠歴残殺毒氏民求治法" ++ + "泣浅浴清満漁灯無然焼照熱牧特産的省祝票種" ++ + "積競笑管節粉紀約結給続置老胃脈腸臣航良芸" ++ + "芽英菜街衣要覚観訓試説課議象貨貯費賞軍輪" ++ + "辞辺連達選郡量録鏡関陸隊静順願類飛飯養験" diff --git a/Data/Kanji/SixthQ.hs b/Data/Kanji/SixthQ.hs new file mode 100644 --- /dev/null +++ b/Data/Kanji/SixthQ.hs @@ -0,0 +1,15 @@ +module Data.Kanji.SixthQ where + +-- | The Kanji unique to Level-6, studied by the end of 5th grade in +-- Japanese elementary schools. +sixthQ :: [Char] +sixthQ = "久仏仮件任似余価保修俵個備像再刊判制券則" ++ + "効務勢厚句可営因団圧在均基報境墓増夢妻婦" ++ + "容寄富導居属布師常幹序弁張往復徳志応快性" ++ + "恩情態慣承技招授採接提損支政故敵断旧易暴" ++ + "条枝査格桜検構武比永河液混減測準演潔災燃" ++ + "版犯状独率現留略益眼破確示祖禁移程税築精" ++ + "素経統絶綿総編績織罪群義耕職肥能興舌舎術" ++ + "衛製複規解設許証評講謝識護豊財貧責貸貿賀" ++ + "資賛質輸述迷退逆造過適酸鉱銅銭防限険際雑" ++ + "非預領額飼" diff --git a/Data/Kanji/TenthQ.hs b/Data/Kanji/TenthQ.hs new file mode 100644 --- /dev/null +++ b/Data/Kanji/TenthQ.hs @@ -0,0 +1,9 @@ +module Data.Kanji.TenthQ where + +-- | The Kanji unique to Level-10, studied by the end of 1st grade in +-- Japanese elementary schools. +tenthQ :: [Char] +tenthQ = "一七三上下中九二五人休先入八六円出力十千" ++ + "口右名四土夕大天女子字学小山川左年手文日" ++ + "早月木本村林校森正気水火犬玉王生田男町白" ++ + "百目石空立竹糸耳花草虫見貝赤足車金雨青音" diff --git a/Data/Kanji/ThirdQ.hs b/Data/Kanji/ThirdQ.hs new file mode 100644 --- /dev/null +++ b/Data/Kanji/ThirdQ.hs @@ -0,0 +1,20 @@ +module Data.Kanji.ThirdQ where + +-- | The Kanji unique to Level-3, studied by the end of middle school +-- in Japan. +thirdQ :: [Char] +thirdQ = "乏乙了企伏伐伴伸佳侍促倣倹偶催債克免冗冠" ++ + "凍凝刑削励勘募匠匿卑卓卸厘又双吉吏哀哲啓" ++ + "喚喫嘱坑埋塊塗墜墨墳墾壇奉契奪如妨姫娯婆" ++ + "婿嫁嬢孔孤宴審寿封尿岐岳峡崩巧帆帝幻幽廉" ++ + "廊弧彫徐忌怠怪恨悔悟悦惜愚慈慌慕慨慰憂憎" ++ + "憩房抑択抽拘掃掌排掛控措掲揚換揺携搾摂撮" ++ + "擁擦敢斗斤斥施既昇晶暫架某桑棄棋楼概欧欺" ++ + "殊殴没泌浪湾湿滅滑滝滞漂漏潜潤濫瀬炉炊炎" ++ + "焦牲犠猟獄甲畔畜疾痘癖硬碑礎祉稚穂穏穫窒" ++ + "符篤簿籍粋粗粘糧紛紺絞綱緊締緩縛縫繕翻聴" ++ + "肝胆胎胞脅膜膨芳苗菊華葬藩虐虚蛮衝衰袋裂" ++ + "裸覆訂託詠該誘請諮諾謀譲豚貫賊賢赦赴超軌" ++ + "軸辛辱逮遂遇遭遵邦邪郊郭酔酵鋳錠錬錯鍛鎮" ++ + "鐘閲阻陪陳陵陶隆随隔隻雇零霊顧飽餓駐騎髄" ++ + "魂魅魔鯨鶏" diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/nanq.cabal b/nanq.cabal new file mode 100644 --- /dev/null +++ b/nanq.cabal @@ -0,0 +1,67 @@ +name: nanq + +category: Natural Language Processing + +version: 1.0.0 + +synopsis: Performs 漢字検定 (National Kanji Exam) level analysis on given Kanji. + +description: `nanq` can inform the user of a number of statistics + regarding Kanji and the Nation Kanji Examination, also + known as 漢字検定 or 漢検. In the most simple case, + it will reveal what inputed Kanji belong to what + Level of the exam. + +homepage: https://github.com/fosskers/nanq + +license: GPL-3 + +license-file: LICENSE + +author: Colin Woodbury + +maintainer: colingw@gmail.com + +build-type: Simple + +cabal-version: >=1.8 + +executable nanq + main-is: nanq.hs + + other-modules: Data.Kanji, + Data.Kanji.TenthQ, + Data.Kanji.NinthQ, + Data.Kanji.EighthQ, + Data.Kanji.SeventhQ, + Data.Kanji.SixthQ, + Data.Kanji.FifthQ, + Data.Kanji.FourthQ, + Data.Kanji.ThirdQ, + Data.Kanji.PreSecondQ, + Data.Kanji.SecondQ + + build-depends: base < 5 + , bytestring >= 0.10.6.0 + , containers >= 0.4.0.0 + , microlens >= 0.3.5.0 + , text + +library + build-depends: base < 5 + , bytestring >= 0.10.6.0 + , containers >= 0.4.0.0 + , microlens >= 0.3.5.0 + , text + + exposed-modules: Data.Kanji, + Data.Kanji.TenthQ, + Data.Kanji.NinthQ, + Data.Kanji.EighthQ, + Data.Kanji.SeventhQ, + Data.Kanji.SixthQ, + Data.Kanji.FifthQ, + Data.Kanji.FourthQ, + Data.Kanji.ThirdQ, + Data.Kanji.PreSecondQ, + Data.Kanji.SecondQ diff --git a/nanq.hs b/nanq.hs new file mode 100644 --- /dev/null +++ b/nanq.hs @@ -0,0 +1,168 @@ +import Data.Kanji +import Data.List (delete, nub) +import Data.Maybe (fromJust) +import System.Console.GetOpt +import System.Environment (getArgs) +import System.IO (hGetContents, stdin) +import Text.Printf (printf) + +--- + +data Language = Jap | Eng deriving (Show,Eq) + +data Flag = FileInput | PipeInput | Help | Average | + Unknowns | LevelDist | KDensity | Elementary | + Text | JapOutput | AllFromQ Rank deriving (Show,Eq) + +options :: [OptDescr Flag] +options = [ Option ['f'] ["file"] (NoArg FileInput) fDesc + , Option ['p'] ["pipe"] (NoArg PipeInput) pDesc + , Option ['h'] ["help"] (NoArg Help) hDesc + , Option ['a'] ["average"] (NoArg Average) aDesc + , Option ['u'] ["unknowns"] (NoArg Unknowns) uDesc + , Option ['d'] ["leveldist"] (NoArg LevelDist) lDesc + , Option ['k'] ["density"] (NoArg KDensity) kDesc + , Option ['e'] ["elementary"] (NoArg Elementary) eDesc + , Option ['t'] ["text"] (NoArg Text) tDesc + , Option ['j'] ["japanese"] (NoArg JapOutput) jDesc + , Option ['q'] ["fromq"] + (ReqArg (\s -> AllFromQ (read s :: Rank)) "Rank") qDesc + ] + where fDesc = "Takes input from a given file." ++ + "\n入力は指定のファイルから" + pDesc = "Takes input from a pipe (stdin)." ++ + "\n入力はpipe (つまりstdin)から" + hDesc = "Shows this help message." ++ + "\nこのメッセージから出力" + aDesc = "Find the average level of some given line of Japanese." ++ + "\n日本語の文の平均的な級を求める" + uDesc = "Report Kanji whose Level could not be determined." ++ + "\n級を明確にできなかった漢字を報告" + lDesc = "Find the % distribution of levels in given Japanese." ++ + "\nどの級の漢字がどれ程出ているか、パーセントで出力" + kDesc = "Determines how much of the input is made of Kanji." ++ + "\n入力は何パーセント漢字でできているか出力" + eDesc = "Determines how much of the input is made of Kanji" ++ + "\nlearnt in Elementary School in Japan." ++ + "\n入力は何パーセント小学校で習う漢字でできているか出力" + tDesc = "Applies -k -e and -d all at once to analyse some text." ++ + "\n-k、-e、-dを連続に使って入力を分析" + jDesc = "Output is given in Japanese instead of English." ++ + "\n出力の際は日本語" + qDesc = "Filters out all but Kanji from the requested Level." ++ + "\n指定された級の漢字だけ出力" + +usageMsg :: String +usageMsg = "Usage : nanq [OPTION] (kanji / file)" + +japQNames :: [(Rank,String)] +japQNames = zip rankNums ["10級","9級","8級","7級","6級","5級","4級", + "3級", "準2級","2級","準1級","1級"] + +engQNames :: [(Rank,String)] +engQNames = zip rankNums ["Tenth Level","Ninth Level","Eighth Level", + "Seventh Level","Sixth Level","Fifth Level", + "Forth Level","Third Level", "Pre-Second Level", + "Second Level","Pre-First Level","First Level"] + +findAverageQ :: Language -> [Char] -> String +findAverageQ lang ks = + printf (getMsg lang ++ "%.2f") . averageLevel levels . asKanji $ ks + where getMsg Eng = "Average Level: " + getMsg Jap = "平均の級：" + +findQs :: Language -> [Char] -> [String] +findQs lang ks = map (nanQ lang) $ asKanji ks + +nanQ :: Language -> Kanji -> String +nanQ lang k = maybe (bad lang) (good lang . _rank) $ level levels k + where + good Eng n = (show k) ++ " is " ++ (articledQName n) ++ " Kanji." + good Jap n = "「" ++ (show k) ++ "」は" ++ (jQName n) ++ "の漢字" + bad Eng = (show k) ++ " is not in any level." + bad Jap = "「" ++ (show k) ++ "」はどの級の漢字でもない" + articledQName n = getArticle (eQName n) ++ " " ++ eQName n + getArticle name = if head name `elem` "AEIOU" then "an" else "a" + eQName n = getQName n engQNames + jQName n = getQName n japQNames + getQName n names = fromJust $ n `lookup` names + +findUnknowns :: Language -> String -> [String] +findUnknowns lang ks = case unknowns of + [] -> [bad lang] + _ -> good lang : map show unknowns + where unknowns = nub . filter (not . hasLevel levels) . asKanji $ ks + bad Eng = "No Kanji of unknown Level found." + bad Jap = "級を明確にできない漢字は見つからなかった" + good Eng = "The following Kanji of unknown Level were found:" + good Jap = "級を明確にできなかった漢字は：" + +findDistribution :: Language -> String -> [String] +findDistribution lang ks = + map (\(name,per) -> printf "%4s: %05.2f%%" name per) namePercentPairs + where namePercentPairs = map rawToPretty distributions + distributions = levelDist levels $ asKanji ks + rawToPretty (qn,p) = (getQName lang qn, p * 100) + getQName Eng qn = getName engQNames "Above Second Level" qn + getQName Jap qn = getName japQNames "2級以上" qn + getName names msg qn = maybe msg id $ qn `lookup` names + +howMuchIsKanji :: Language -> String -> String +howMuchIsKanji lang ks = printf "%s: %.2f%%" (getMsg lang) percent + where percent = 100 * kanjiDensity ks + getMsg Eng = "Kanji Density" + getMsg Jap = "漢字率" + +howMuchIsElementaryKanji :: Language -> String -> String +howMuchIsElementaryKanji lang ks = printf (getMsg lang) percent + where percent = 100 * elementaryKanjiDensity ks + getMsg Eng = "Input Kanji is %.2f%% Elementary School Kanji." + getMsg Jap = "入力した漢字は「%.2f%%」小学校で習う漢字。" + +getAllFromLevel :: Rank -> [Char] -> [Kanji] +getAllFromLevel qn ks = maybe [] f $ levelFromRank levels qn + where f q = nub . filter (isKanjiInLevel q) . asKanji $ ks + +parseOpts :: [String] -> IO ([Flag],[String]) +parseOpts args = case getOpt Permute options args of + (opts,nonopts,[]) -> return (opts,nonopts) + (_,_,_) -> argError "Bad flag used." + +-- Determine input source and output language. +cleanOpts :: ([Flag],[String]) -> IO ([Flag],Language,String) +cleanOpts (opts,nonopts) = clean opts nonopts Eng -- English by default. + where clean opts nonopts lang + | JapOutput `elem` opts = clean (without JapOutput) nonopts Jap + | Help `elem` opts = return ([Help],lang,"") + | PipeInput `elem` opts = do input <- hGetContents stdin + return (without PipeInput,lang,input) + | null nonopts = argError "No Kanji / file given!" + | FileInput `elem` opts = do input <- readFile $ head nonopts + return (without FileInput,lang,input) + | otherwise = return (opts,lang,head nonopts) + where without x = delete x opts + +executeOpts :: ([Flag],Language,String) -> IO () +executeOpts (flags,lang,input) = + case flags of + [Help] -> putStr $ usageInfo usageMsg options + [Average] -> putStrLn $ findAverageQ lang input + [] -> mapM_ putStrLn $ findQs lang input + [Unknowns] -> mapM_ putStrLn $ findUnknowns lang input + [LevelDist] -> mapM_ putStrLn $ findDistribution lang input + [KDensity] -> putStrLn $ howMuchIsKanji lang input + [Elementary] -> putStrLn $ howMuchIsElementaryKanji lang input + [Text] -> mapM_ execAll [KDensity,Elementary,LevelDist] + [AllFromQ qn] -> mapM_ print $ getAllFromLevel qn input + _ -> argError "Conflicting flags given." + where execAll flag = executeOpts ([flag],lang,input) >> putStrLn "" + +argError :: String -> a +argError msg = error $ usageInfo (msg ++ "\n" ++ usageMsg) options + +main :: IO () +main = do + args <- getArgs + opts <- parseOpts args + cleanedOpts <- cleanOpts opts + executeOpts cleanedOpts