mod.go

package neng

// Mod holds modification parameters for a generated word.
type Mod uint

// Do not transform the word in any way.
const MOD_NONE Mod = 0

const (
	// Transform a noun or a verb (Past Simple, Present Simple)
	// into its plural form.
	MOD_PLURAL Mod = 1 << iota

	// Transform a verb into its Past Simple form.
	MOD_PAST_SIMPLE

	// Transform a verb into its Past Participle form.
	MOD_PAST_PARTICIPLE

	// Add Present Simple suffix to a verb (-s, -es).
	MOD_PRESENT_SIMPLE

	// Create gerund form of a verb (-ing).
	MOD_GERUND

	// Transform an adjective or an adverb into comparative (good -> better).
	MOD_COMPARATIVE

	// Transform an adjective or an adverb into superlative (good -> best).
	MOD_SUPERLATIVE

	// Insert an indefinite article before an adjective, adverb or a noun.
	MOD_INDEF

	// Pick a noun that is compatible with MOD_INDEF (not uncountable,
	// not plural-only). Helpful when the user wants to add the indefinite
	// article before an adjective describing a noun.
	MOD_INDEF_SILENT

	// Transform a word to lower case.
	MOD_CASE_LOWER

	// In a group of words, transform the first one to title case
	// and everything that follows to lower case. If there is only
	// one word (no spaces), MOD_CASE_TITLE is applied.
	MOD_CASE_SENTENCE

	// Transform a word to Title Case.
	MOD_CASE_TITLE

	// Transform a word to UPPER CASE.
	MOD_CASE_UPPER

	// Internal value, declared to mark the end of usable Mod values.
	mod_undefined
)

// Enabled returns true if any of the specified mods are enabled in m.
// Do not use this method to test for MOD_NONE. Use a simple comparison instead.
func (m Mod) Enabled(mods Mod) bool {
	return m&mods != 0
}

// Undefined returns true if m holds an undefined Mod value.
func (m Mod) Undefined() bool {
	return m >= mod_undefined
}

// specToMod translates specifier (phrase pattern syntax character)
// into a corresponding Mod value.
func specToMod(spec rune) Mod {
	switch spec {
	case 'p':
		return MOD_PLURAL
	case '2':
		return MOD_PAST_SIMPLE
	case '3':
		return MOD_PAST_PARTICIPLE
	case 'N':
		return MOD_PRESENT_SIMPLE
	case 'c':
		return MOD_COMPARATIVE
	case 'f':
		return MOD_CASE_SENTENCE
	case 'g':
		return MOD_GERUND
	case 'i':
		return MOD_INDEF
	case 'l':
		return MOD_CASE_LOWER
	case 's':
		return MOD_SUPERLATIVE
	case 't':
		return MOD_CASE_TITLE
	case 'u':
		return MOD_CASE_UPPER
	case '_':
		return MOD_INDEF_SILENT
	default:
		return mod_undefined
	}
}