refactor noun phrase to english

JoeZZG · JoeZZG · commit 7c81abd8ba9d · 2026-02-10T12:47:43.000-05:00
diff --git a/code/drasil-lang/lib/Language/Drasil.hs b/code/drasil-lang/lib/Language/Drasil.hs
@@ -309,7 +309,7 @@ import Language.Drasil.Data.Citation (CiteField(..), HP(..), CitationKind(..)
   , organization, publisher, school, series, title, typeField
   , chapter, edition, number, volume, year, month, pages
   , compareAuthYearTitle)
-import Language.Drasil.NounPhrase
+import Language.Drasil.NaturalLanguage.English.NounPhrase
 import Language.Drasil.ShortName (ShortName, shortname', getSentSN, HasShortName(..))
 import Language.Drasil.Space (Space(..), RealInterval(..), Inclusive(..),
   RTopology(..), DomainDesc(..), ContinuousDomainDesc, DiscreteDomainDesc,
diff --git a/code/drasil-lang/lib/Language/Drasil/Chunk/CommonIdea.hs b/code/drasil-lang/lib/Language/Drasil/Chunk/CommonIdea.hs
@@ -19,7 +19,7 @@ import Utils.Drasil (repUnd)
 import Language.Drasil.Chunk.NamedIdea (IdeaDict, nc)
 import Language.Drasil.Classes (NamedIdea(term), Idea(getA),
  CommonIdea(abrv), ConceptDomain(cdom))
-import Language.Drasil.NounPhrase.Core (NP)
+import Language.Drasil.NaturalLanguage.English.NounPhrase.Core (NP)
 
 -- | The common idea (with 'NounPhrase') data type. It must have a 'UID',
 -- 'NounPhrase' for its term, an abbreviation ('String'), and a domain (['UID']).
diff --git a/code/drasil-lang/lib/Language/Drasil/Chunk/Concept.hs b/code/drasil-lang/lib/Language/Drasil/Chunk/Concept.hs
@@ -15,7 +15,7 @@ import Language.Drasil.Classes (Idea, Definition(defn), ConceptDomain(cdom), Con
 import Language.Drasil.Chunk.Concept.Core (ConceptChunk(ConDict), ConceptInstance(ConInst))
 import Language.Drasil.Sentence (Sentence(S))
 import Language.Drasil.Chunk.NamedIdea(mkIdea,nw, nc)
-import Language.Drasil.NounPhrase (NP, pn)
+import Language.Drasil.NaturalLanguage.English.NounPhrase (NP, pn)
 import Language.Drasil.ShortName (shortname')
 
 --FIXME: Temporary ConceptDomain tag hacking to not break everything.
diff --git a/code/drasil-lang/lib/Language/Drasil/Chunk/Concept/NamedCombinators.hs b/code/drasil-lang/lib/Language/Drasil/Chunk/Concept/NamedCombinators.hs
@@ -42,12 +42,12 @@ import Drasil.Database ((+++!))
 
 import Language.Drasil.Chunk.NamedIdea (IdeaDict, ncUID)
 import Language.Drasil.Classes (Idea, NamedIdea(..))
-import Language.Drasil.NounPhrase (NP, CapitalizationRule(CapWords, Replace,
+import Language.Drasil.NaturalLanguage.English.NounPhrase (NP, CapitalizationRule(CapWords, Replace,
   CapFirst), NounPhrase(phraseNP, pluralNP), nounPhrase'', compoundPhrase,
   compoundPhrase'', compoundPhrase''')
-import Language.Drasil.NounPhrase.Core (NPStruct(S,(:+:)))
-import qualified Language.Drasil.NounPhrase as D (NounPhrase(pluralNP, phraseNP))
-import qualified Language.Drasil.NounPhrase.Combinators as NP (
+import Language.Drasil.NaturalLanguage.English.NounPhrase.Core (NPStruct(S,(:+:)))
+import qualified Language.Drasil.NaturalLanguage.English.NounPhrase as D (NounPhrase(pluralNP, phraseNP))
+import qualified Language.Drasil.NaturalLanguage.English.NounPhrase.Combinators as NP (
   insertString, insertStringOp, insertStringGen)
 
 -- not exported
diff --git a/code/drasil-lang/lib/Language/Drasil/Chunk/Constrained.hs b/code/drasil-lang/lib/Language/Drasil/Chunk/Constrained.hs
@@ -21,7 +21,7 @@ import Language.Drasil.Constraint (ConstraintE)
 import Language.Drasil.Chunk.UnitDefn (unitWrapper, MayHaveUnit(getUnit))
 import Language.Drasil.Expr.Lang (Expr(..))
 import Language.Drasil.Expr.Class (sy)
-import Language.Drasil.NounPhrase.Core (NP)
+import Language.Drasil.NaturalLanguage.English.NounPhrase.Core (NP)
 import Language.Drasil.Sentence (Sentence(S))
 import Language.Drasil.Space (Space, HasSpace(..))
 import Language.Drasil.Stages (Stage)
diff --git a/code/drasil-lang/lib/Language/Drasil/Chunk/DefinedQuantity.hs b/code/drasil-lang/lib/Language/Drasil/Chunk/DefinedQuantity.hs
@@ -23,7 +23,7 @@ import Language.Drasil.Chunk.UnitDefn (UnitDefn, unitWrapper,
   MayHaveUnit(getUnit))
 import Language.Drasil.Space (Space, HasSpace(..))
 import Language.Drasil.Stages (Stage (Implementation, Equational))
-import Language.Drasil.NounPhrase.Core (NP)
+import Language.Drasil.NaturalLanguage.English.NounPhrase.Core (NP)
 import Language.Drasil.Sentence (Sentence)
 
 -- | DefinedQuantityDict is the combination of a 'Concept' and a 'Quantity'.
diff --git a/code/drasil-lang/lib/Language/Drasil/Chunk/Eq.hs b/code/drasil-lang/lib/Language/Drasil/Chunk/Eq.hs
@@ -31,7 +31,7 @@ import Language.Drasil.Expr.Class (ExprC(apply, sy, ($=)))
 import Language.Drasil.Literal.Lang (Literal)
 import Language.Drasil.ModelExpr.Class (ModelExprC(defines))
 import qualified Language.Drasil.ModelExpr.Lang as M (ModelExpr(C))
-import Language.Drasil.NounPhrase.Core (NP)
+import Language.Drasil.NaturalLanguage.English.NounPhrase.Core (NP)
 import Language.Drasil.Space (Space(..), HasSpace(..))
 import Language.Drasil.Sentence (Sentence(EmptyS))
 import Language.Drasil.Stages (Stage)
diff --git a/code/drasil-lang/lib/Language/Drasil/Chunk/NamedIdea.hs b/code/drasil-lang/lib/Language/Drasil/Chunk/NamedIdea.hs
@@ -13,7 +13,7 @@ import Control.Lens ((^.), makeLenses, Lens')
 
 import Drasil.Database (mkUid, UID, HasUID(..), declareHasChunkRefs,
   Generically(..), IsChunk)
-import Language.Drasil.NounPhrase.Core (NP)
+import Language.Drasil.NaturalLanguage.English.NounPhrase.Core (NP)
 
 -- | A NamedIdea is a 'term' that we've identified (has a 'UID') as being worthy
 -- of naming.
diff --git a/code/drasil-lang/lib/Language/Drasil/Chunk/Relation.hs b/code/drasil-lang/lib/Language/Drasil/Chunk/Relation.hs
@@ -14,7 +14,7 @@ import Language.Drasil.Chunk.Concept (ConceptChunk, dccWDS)
 import Language.Drasil.Classes (Express(..),
   ConceptDomain(..), Definition(..), Idea(..), NamedIdea(..))
 import Language.Drasil.ModelExpr.Lang (ModelExpr)
-import Language.Drasil.NounPhrase.Core (NP)
+import Language.Drasil.NaturalLanguage.English.NounPhrase.Core (NP)
 import Language.Drasil.Sentence (Sentence)
 
 -- | For a concept ('ConceptChunk') that also has a 'Relation' ('ModelExpr') attached.
diff --git a/code/drasil-lang/lib/Language/Drasil/Chunk/UncertainQuantity.hs b/code/drasil-lang/lib/Language/Drasil/Chunk/UncertainQuantity.hs
@@ -21,7 +21,7 @@ import Language.Drasil.Constraint (ConstraintE)
 import Language.Drasil.Chunk.UnitDefn (MayHaveUnit(getUnit))
 import Language.Drasil.Expr.Lang (Expr)
 import Language.Drasil.Expr.Class (sy)
-import Language.Drasil.NounPhrase.Core (NP)
+import Language.Drasil.NaturalLanguage.English.NounPhrase.Core (NP)
 import Language.Drasil.Space (Space, HasSpace(..))
 import Language.Drasil.Uncertainty
 
diff --git a/code/drasil-lang/lib/Language/Drasil/Chunk/UnitDefn.hs b/code/drasil-lang/lib/Language/Drasil/Chunk/UnitDefn.hs
@@ -28,7 +28,7 @@ import Drasil.Database (HasChunkRefs(..), UID, HasUID(..), mkUid)
 import Language.Drasil.Chunk.Concept (ConceptChunk, dcc, cc')
 import Language.Drasil.Classes (NamedIdea(term), Idea(getA),
   Definition(defn), ConceptDomain(cdom), HasUnitSymbol(usymb), IsUnit(udefn, getUnits))
-import Language.Drasil.NounPhrase (cn,cn',NP)
+import Language.Drasil.NaturalLanguage.English.NounPhrase (cn,cn',NP)
 import Language.Drasil.Symbol (Symbol(Label))
 import Language.Drasil.UnitLang (USymb(US), UDefn(UScale, USynonym, UShift),
   compUSymb, fromUDefn, getUSymb, getDefn, UnitSymbol(BaseSI, DerivedSI, Defined))
diff --git a/code/drasil-lang/lib/Language/Drasil/Chunk/Unital.hs b/code/drasil-lang/lib/Language/Drasil/Chunk/Unital.hs
@@ -18,7 +18,7 @@ import Language.Drasil.Classes (NamedIdea(term), Idea(getA), Express(express),
   Definition(defn), ConceptDomain(cdom), Concept, IsUnit, Quantity)
 import Language.Drasil.Chunk.UnitDefn (MayHaveUnit(getUnit), TempHasUnit(findUnit),  UnitDefn, unitWrapper)
 import Language.Drasil.Expr.Class (sy)
-import Language.Drasil.NounPhrase.Core (NP)
+import Language.Drasil.NaturalLanguage.English.NounPhrase.Core (NP)
 import Language.Drasil.Space (Space(..), HasSpace(..))
 import Language.Drasil.Sentence (Sentence)
 import Language.Drasil.Stages (Stage)
diff --git a/code/drasil-lang/lib/Language/Drasil/Development.hs b/code/drasil-lang/lib/Language/Drasil/Development.hs
@@ -14,7 +14,7 @@ module Language.Drasil.Development (
 ) where
 
 import Language.Drasil.Development.Sentence (toSent)
-import Language.Drasil.NounPhrase (NounPhrase(..))
-import Language.Drasil.NounPhrase.Core (NPStruct(..))
+import Language.Drasil.NaturalLanguage.English.NounPhrase (NounPhrase(..))
+import Language.Drasil.NaturalLanguage.English.NounPhrase.Core (NPStruct(..))
 import Language.Drasil.Sentence (sdep, shortdep, lnames, lnames')
 import Drasil.Database (showUID)
diff --git a/code/drasil-lang/lib/Language/Drasil/Development/Sentence.hs b/code/drasil-lang/lib/Language/Drasil/Development/Sentence.hs
@@ -24,8 +24,8 @@ import Language.Drasil.Chunk.NamedIdea (NamedIdea(term), Idea)
 import Language.Drasil.Sentence ((+:+), sParen, sentenceTerm,
   sentencePlural, sentenceShort)
 import qualified Language.Drasil.Sentence as S
-import qualified Language.Drasil.NounPhrase as NP
-import Language.Drasil.NounPhrase.Core (NPStruct(..))
+import qualified Language.Drasil.NaturalLanguage.English.NounPhrase as NP
+import Language.Drasil.NaturalLanguage.English.NounPhrase.Core (NPStruct(..))
 
 -- | Translate from NPStruct to Sentence
 toSent :: NPStruct -> S.Sentence
diff --git a/code/drasil-lang/lib/Language/Drasil/NaturalLanguage/English/NounPhrase.hs b/code/drasil-lang/lib/Language/Drasil/NaturalLanguage/English/NounPhrase.hs
@@ -1,4 +1,4 @@
-module Language.Drasil.NounPhrase (
+module Language.Drasil.NaturalLanguage.English.NounPhrase (
   -- * Types
   NounPhrase(..), NP,
   -- * Phrase Accessors
@@ -20,7 +20,7 @@ module Language.Drasil.NounPhrase (
 
 import Data.Char (isLatin1, isLetter, toLower, toUpper)
 
-import Language.Drasil.NounPhrase.Core -- uses whole module
+import Language.Drasil.NaturalLanguage.English.NounPhrase.Core -- uses whole module
 
 --Linguistically, nounphrase might not be the best name (yet!), but once
 -- it is fleshed out and/or we do more with it, it will likely be a good fit
diff --git a/code/drasil-lang/lib/Language/Drasil/NaturalLanguage/English/NounPhrase/Combinators.hs b/code/drasil-lang/lib/Language/Drasil/NaturalLanguage/English/NounPhrase/Combinators.hs
@@ -0,0 +1,169 @@
+-- | Defines various NounPhrase-level combinators. These hold more information
+-- than those of the Sentence level but may not necessarily have a conceptual link.
+-- See the [Wiki](https://github.com/JacquesCarette/Drasil/wiki/Combinator-Documentation)
+-- for more information and details about the naming process for combinators.
+-- A summary of the function naming scheme is as follows:
+--
+--    * Combinators that conflict with haskell-native functions have an underscore appended.
+--    * Default plural case for combinators will be first term singular, second term plural.
+--    * @P@ and @S@ denote the plural case of the combinator when it does not follow the above default.
+--    * @Gen@ denotes the general function case.
+--
+-- This module should be used as a qualified import (usually as @NP@),
+-- as many function names clash with those in Concepts.hs and Sentence.hs.
+module Language.Drasil.NaturalLanguage.English.NounPhrase.Combinators (
+  -- * General Combinator Helper Functions
+  insertString, prependString, insertStringOp, insertStringGen,
+  -- * Prepositions
+  -- ** \"The\" Combinators
+  the, theGen,
+  -- ** \"A\" Combinators
+  a_, a_Gen,
+  -- * Conjunctions
+  -- ** \"And\" Combinators
+  and_, and_PS, and_Gen, andThe,
+  -- ** \"The\" Combinators
+  ofThe, ofThePS, ofTheGen, inThe, inThePS, inTheGen,
+  the_ofThe, the_ofThePS, the_ofTheGen,
+  -- ** \"For\" Combinators
+  for, forPS, forGen,
+  -- ** \"Of\" Combinators
+  of_, of_PS, of_Gen,
+  -- ** Other Combinators
+  with, parensNP,
+  -- re-exports
+  NPStruct((:+:), S, P)
+) where
+
+import Language.Drasil.NaturalLanguage.English.NounPhrase
+    ( NP,
+      CapitalizationRule(CapWords, CapFirst, CapNothing),
+      NounPhrase(phraseNP, pluralNP),
+      nounPhrase'', surroundNPStruct)
+import Language.Drasil.NaturalLanguage.English.NounPhrase.Core (NPStruct((:+:),S,P))
+
+--Maybe move these to a separate Drasil.NounPhrase section
+-- | Helper function that places a 'String' in between two 'NP's. Plural case is
+-- @(phraseNP t1) :+: S s :+: (pluralNP t2)@.
+insertString :: String -> NP -> NP -> NP
+insertString s t1 t2 = nounPhrase'' (phraseNP t1 :+: S s :+: phraseNP t2) (phraseNP t1 :+: S s :+: pluralNP t2) CapFirst CapWords
+
+-- | Helper function that places a 'String' in between two 'NP's. Plural case is
+-- @(pluralNP t1) :+: S s :+: (phraseNP t2)@, i.e. opposite of 'insertString'
+insertStringOp :: String -> NP -> NP -> NP
+insertStringOp s t1 t2 = nounPhrase'' (phraseNP t1 :+: S s :+: phraseNP t2) (pluralNP t1 :+: S s :+: phraseNP t2) CapFirst CapWords
+
+-- | Helper function that places a 'String' in between two 'NP's. Plural case is
+-- given by two generic functions.
+insertStringGen :: String -> (NP -> NPStruct) -> (NP -> NPStruct) -> NP -> NP -> NP
+insertStringGen s f1 f2 t1 t2 = nounPhrase'' (phraseNP t1 :+: S s :+: phraseNP t2) (f1 t1 :+: S s :+: f2 t2) CapFirst CapWords
+
+-- | Helper function that prepends a 'String' to a 'NP'.
+prependString :: String -> NP -> NP
+prependString s t1 = nounPhrase'' (S s :+: phraseNP t1) (S s :+: pluralNP t1) CapFirst CapWords
+
+-- | Prepends a 'String' to an 'NP' and adjust the plural
+prependStringGen :: String -> (NP -> NPStruct) -> NP -> NP
+prependStringGen s f t = nounPhrase'' (S s :+: phraseNP t) (S s :+: f t) CapFirst CapWords
+
+-- surrounding something makes it no capitalizatble at all
+surround :: String -> String -> NP -> NP
+surround l r t = nounPhrase'' (surroundNPStruct l r (phraseNP t)) (surroundNPStruct l r (pluralNP t)) CapNothing CapNothing
+
+{-
+-- | Helper function that places a 'Sentence' in between two 'NP's. Plural case is
+-- @(phraseNP t1) :+: s :+: (pluralNP t2)@.
+insertSent :: Sentence -> NP -> NP -> NP
+insertSent s t1 t2 = nounPhrase'' (phraseNP t1 :+: s :+: phraseNP t2) (phraseNP t1 :+: s :+: pluralNP t2) CapFirst CapWords
+
+-- | Helper function that prepends a 'Sentence' to a 'NP'.
+prependSent :: Sentence -> NP -> NP
+prependSent s t1 = nounPhrase'' (s :+: phraseNP t1) (s :+: pluralNP t1) CapFirst CapWords
+-}
+
+-- | Prepends "the" to a 'NP'.
+the :: NP -> NP
+the = prependString "the"
+-- | Similar to 'the', but accepts a function that determines the plural case.
+theGen :: (NP -> NPStruct) -> NP -> NP
+theGen = prependStringGen "the"
+
+-- | Prepends "a" to a 'NP'.
+a_ :: NP -> NP
+a_ = prependString "a"
+-- | Similar to 'a', but accepts a function that determines the plural case.
+a_Gen :: (NP -> NPStruct) -> NP -> NP
+a_Gen = prependStringGen "a"
+
+-- | Inserts "of the" between two 'NP's. Plural case is @(phraseNP t1) :+: "of the" :+: (pluralNP t2)@.
+ofThe :: NP -> NP -> NP
+ofThe = insertString "of the"
+-- | Similar to 'ofThe', but the plural case is now @(pluralNP t1) `ofThe` (phraseNP t2)@.
+--
+ofThePS :: NP -> NP -> NP
+ofThePS = insertStringOp "of the"
+-- | Similar to 'ofThe', but accepts two functions for the plural case.
+ofTheGen :: (NP -> NPStruct) -> (NP -> NPStruct) -> NP -> NP -> NP
+ofTheGen = insertStringGen "of the"
+
+-- | Inserts "in the" between two 'NP's. Plural case is @(phraseNP t1) :+: "in the" :+: (pluralNP t2)@.
+inThe :: NP -> NP -> NP
+inThe = insertString "in the"
+-- | Similar to 'ofThe', but the plural case is now @(pluralNP t1) `inThe` (phraseNP t2)@.
+inThePS :: NP -> NP -> NP
+inThePS = insertStringOp "in the"
+-- | Similar to 'ofThe', but accepts two functions for the plural case.
+inTheGen :: (NP -> NPStruct) -> (NP -> NPStruct) -> NP -> NP -> NP
+inTheGen = insertStringGen "in the"
+
+-- | Prepends "the" and inserts "of the". Plural case is @"the" :+: (phraseNP t1) :+: "of the" :+: (pluralNP t2)@.
+the_ofThe :: NP -> NP -> NP
+the_ofThe t1 t2 = the t1 `ofThe` t2
+-- | Similar to 'the_ofThe', but the plural case is now @ S "the" :+: (pluralNP t1) `ofThe` (phraseNP t2)@.
+the_ofThePS :: NP -> NP -> NP
+the_ofThePS t1 t2 = the t1 `ofThePS` t2
+-- | Similar to 'the_ofThe'', but takes two functions for the plural case.
+the_ofTheGen :: (NP -> NPStruct) -> (NP -> NPStruct) -> NP -> NP -> NP
+the_ofTheGen f1 f2 t1 = ofTheGen f1 f2 (the t1)
+
+-- | Inserts "for" between two 'NP's. Plural case is @(phraseNP t1) :+: "for" :+: (pluralNP t2)@.
+for :: NP -> NP -> NP
+for = insertString "for"
+-- | Same as 'for', but plural case is now @(pluralNP t1) `for` (phraseNP t2)@.
+forPS :: NP -> NP -> NP
+forPS = insertStringOp "for"
+-- | Same as 'for'', but takes two functions for the plural case.
+forGen :: (NP -> NPStruct) -> (NP -> NPStruct) -> NP -> NP -> NP
+forGen = insertStringGen "for"
+
+-- | Inserts "of" between two 'NP's. Plural case is @(phraseNP t1) :+: "of" :+: (pluralNP t2)@.
+of_ :: NP -> NP -> NP
+of_ = insertString "of"
+-- | Same as 'of_', but plural case is now @(pluralNP t1) `of_` (phraseNP t2)@.
+of_PS :: NP -> NP -> NP
+of_PS = insertStringOp "of"
+-- | Same as 'of_', but takes two functions for the plural case.
+of_Gen :: (NP -> NPStruct) -> (NP -> NPStruct) -> NP -> NP -> NP
+of_Gen = insertStringGen "of"
+
+-- | Inserts "with" between two 'NP's. Plural case is @(phraseNP t1) :+: "with" :+: (pluralNP t2)@.
+with :: NP -> NP -> NP
+with = insertString "with"
+
+-- | Inserts "and" between two 'NP's. Plural case is @(phraseNP t1) :+: "and" :+: (pluralNP t2)@.
+and_ :: NP -> NP -> NP
+and_ = insertString "and"
+-- | Same as 'and_', but plural case is now @(pluralNP t1) `and_` (phraseNP t2)@.
+and_PS :: NP -> NP -> NP
+and_PS = insertStringOp "and"
+-- | Same as 'and_', but takes two functions for the plural case.
+and_Gen :: (NP -> NPStruct) -> (NP -> NPStruct) -> NP -> NP -> NP
+and_Gen = insertStringGen "and"
+
+-- | Inserts "and the" between two 'NP's. Plural case is @(phraseNP t1) :+: "and the" :+: (pluralNP t2)@.
+andThe :: NP -> NP -> NP
+andThe = insertString "and the"
+
+-- | Puts parentheses around a word; to be used as a kind of postfix qualifier
+parensNP :: NP -> NP
+parensNP = surround "(" ")"
diff --git a/code/drasil-lang/lib/Language/Drasil/NaturalLanguage/English/NounPhrase/Core.hs b/code/drasil-lang/lib/Language/Drasil/NaturalLanguage/English/NounPhrase/Core.hs
@@ -1,5 +1,5 @@
 -- | Basic data types for noun phrases.
-module Language.Drasil.NounPhrase.Core (
+module Language.Drasil.NaturalLanguage.English.NounPhrase.Core (
   -- * Types
   CapitalizationRule(..), NP(..),
   PluralForm, PluralRule(..),
diff --git a/code/drasil-lang/lib/Language/Drasil/NaturalLanguage/English/NounPhrase/README.md b/code/drasil-lang/lib/Language/Drasil/NaturalLanguage/English/NounPhrase/README.md
diff --git a/code/drasil-lang/lib/Language/Drasil/NounPhrase/Combinators.hs b/code/drasil-lang/lib/Language/Drasil/NounPhrase/Combinators.hs
diff --git a/code/drasil-lang/lib/Language/Drasil/Sentence.hs b/code/drasil-lang/lib/Language/Drasil/Sentence.hs
diff --git a/code/drasil-lang/lib/Language/Drasil/Sentence/Generators.hs b/code/drasil-lang/lib/Language/Drasil/Sentence/Generators.hs
diff --git a/code/drasil-lang/package.yaml b/code/drasil-lang/package.yaml
