utils

utils

import "github.com/Qithub-BOT/QiiTrans/src/utils"

Index

• Constants
• Variables
• func DelimitComma(i int) string
• func EchoSTDERR(format string, a ...interface{})
• func ExitOnErr(err error)
• func GetListLang() map[string]string
• func GetNameExe() string
• func GetSTDIN() (stdin string, err error)
• func Hash(algo string, value string) (string, []byte, error)
• func InteractSTDIN(funcUser func(string) error, stopWord string, prompt string) (err error)
• func IsDir(pathFile string) bool
• func IsEnglish(input string) bool
• func IsFile(pathFile string) bool
• func IsModeDebug() bool
• func IsTerminal() bool
• func IsValidLang(lang string) bool
• func LogDebug(log string, a ...interface{})
• func PanicOnErr(err error)
• func PathExists(pathFile string) bool
• func PrintMsgWait(msg string) (setoff func())
• func SetModeDebug(flag bool)
• func SliceSentences(inputText string) []string
• func SliceToSentenceChore(inputText string) []string
• func SliceToSentenceEng(inputTextEn string) []string

Constants

const (
    // SUCCESS は成功時の終了ステータスです.
    SUCCESS int = 0

    // FAILURE 失敗時の終了ステータスです.
    FAILURE int = 1
)

Variables

var (
    // ValSTDINDummy は GetSTDIN() の挙動を mock するための値です.
    //
    // この値が空ではない場合、そのセットされた値を返します.
    ValSTDINDummy string = ""

    // ForceErrorGetSTDIN はテスト用の変数です。true の場合、GetSTDIN は強制的にエラーを返します.
    //
    // この設定はテストで強制的にエラーを発生したい場合に利用されます.
    ForceErrorGetSTDIN bool = false
)

IsTerminalDummy はテスト時に標準入力からの受け取りをモックするために使われる値です. 値を true に設定すると IsTerminal() は強制的に true を返します。false に設定した場合は、自動検知が働きます.

var IsTerminalDummy bool = false

OsExit は os.Exit のエイリアスです. テストで os.Exit の終了ステータスをモックする場合に使われます.

var OsExit = os.Exit

var isModeDebug bool = false

listLang は利用可能な言語のマップです. 自動生成されるため GetListLang() か IsValidLang() を利用してください.

var listLang map[string]string

func DelimitComma

func DelimitComma(i int) string

DelimitComma は int の値を 3 桁ごとにカンマを入れます（1000 -> 1,000）.

func EchoSTDERR

func EchoSTDERR(format string, a ...interface{})

EchoSTDERR は fmt.Fprintf のラッパー関数で、標準エラー出力に出力します.

func ExitOnErr

func ExitOnErr(err error)

ExitOnErr は err がエラーの場合のみ、エラー内容を標準エラー出力に出力して OsExit(1) を呼び出します.

func GetListLang

func GetListLang() map[string]string

GetListLang は、翻訳に使える言語の一覧をマップで返します.

"map[検索]: 指定フォーマット" の形で返ってくるので、バリデーションに使います. "japanese" でキーを検索すると "ja"、"JA" でキーを検索しても "ja" が取得できます.

func GetNameExe

func GetNameExe() string

GetNameExe は、コマンド名（現在の実行ファイル名からパスと拡張子を除いたファイル名）を返します.

func GetSTDIN

func GetSTDIN() (stdin string, err error)

GetSTDIN はパイプ渡し or リダイレクトされた標準入力からのデータを返します.

対話式で標準入力を取得したい場合は InteractSTDIN() を利用してください.

func Hash

func Hash(algo string, value string) (string, []byte, error)

Hash は指定されたアルゴリズムを使って value をハッシュ化し、文字列と byte で結果を返します.

Supported hash

fnv1_32    (checksum usage, 4 byte, 8 char length)
fnv1_64    (checksum usage, 8 byte, 16 char length)
md5        (checksum usage, 16 byte, 32 char length)
sha2_256   (casual usage, 32 byte, 64 char length)
blake3_256 (experimental, 32 byte, 64 char length)
sha3_256   (recommended, 32 byte, 64 char length)
sha2_512   (recommended, 64 byte, 128 char length)
sha3_512   (recommended, 64 byte, 128 char length)
blake3_512 (experimental, 64 byte, 64 char length)

func InteractSTDIN

func InteractSTDIN(funcUser func(string) error, stopWord string, prompt string) (err error)

InteractSTDIN は対話モードで標準入力を処理します.

標準入力から stopWord が入力されるまで、funcUser() に標準入力の値を入れた結果を表示し続けます. 単発の標準入力が欲しい場合は GetSTDIN() を利用してください.

func IsDir

func IsDir(pathFile string) bool

IsDir は pathFile のパスが存在し、ディレクトリの場合に true を返します.

パスの構文解析に失敗した場合はエラーで終了（OsExit）します.

func IsEnglish

func IsEnglish(input string) bool

IsEnglish は input が英文であると予測した場合に true を返します.

この関数は、文書を文に分けて翻訳＆キャッシュをする際に使われます.

func IsFile

func IsFile(pathFile string) bool

IsFile は pathFile のパスが存在し、ファイルの場合に true を返します.

パスの構文解析に失敗した場合はエラーで終了（OsExit）します.

func IsModeDebug

func IsModeDebug() bool

IsModeDebug はデバッグ・モードの場合に true を返します.

Verbose 出力と異なり、ユーザ・サポートに必要な情報を出力する場合などに使います. デバッグ・モードの設定は SetModeDebut() を使います.

func IsTerminal

func IsTerminal() bool

IsTerminal はアプリがターミナル（コマンドライン）で実行されているか返します.

テストでは必ず false になるため、テストでこの挙動を変えたい場合は IsTerminalDummy の値を true にします.

func IsValidLang

func IsValidLang(lang string) bool

IsValidLang は lang が QiiTrans の引数として有効な書式かチェックします.

func LogDebug

func LogDebug(log string, a ...interface{})

LogDebug はデバッグ・モードが true の場合のみ標準エラー出力に出力します.

デバッグ・モードをセットするには SetModeDebug() を使ってください.

func PanicOnErr

func PanicOnErr(err error)

PanicOnErr は err がエラーの場合のみパニックを発生します.

OsExit では都合が悪い時（defer を実行させる必要があるなど）に利用します.

func PathExists

func PathExists(pathFile string) bool

PathExists はパスが存在する場合に true を返します.

func PrintMsgWait

func PrintMsgWait(msg string) (setoff func())

PrintMsgWait は msg を改行なしで標準出力に出力するだけですが、そのメッセージ

を打ち消すための関数を返します。

打ち消し関数を呼び出す前に別の標準出力があった場合は正常に打ち消されません。

func SetModeDebug

func SetModeDebug(flag bool)

SetModeDebug はデバッグ・モードのオン・オフを行います.

引数を true でセットすると GetModeDebug() は true を返します.

func SliceSentences

func SliceSentences(inputText string) []string

SliceSentences は文字列を文の区切りごとにスライスにします.

func SliceToSentenceChore

func SliceToSentenceChore(inputText string) []string

SliceToSentenceChore は英語以外の文字列として文の区切りごとにスライスするのに使われます.

func SliceToSentenceEng

func SliceToSentenceEng(inputTextEn string) []string

SliceToSentenceEng は英語の文字列として文の区切りごとにスライスするのに使われます.

Generated by gomarkdoc