ogma-core-1.15.0: Ogma: Helper tool to interoperate between Copilot and other languages.

Safe Haskell	None
Language	Haskell2010

Command.Search

Description

Find elements in a project that meet a search query.

Synopsis

command :: CommandOptions -> IO (Maybe CommandSearchResults, Result ErrorCode)
data CommandOptions = CommandOptions {
- commandInputFiles :: [SearchFile]
- commandSearchQuery :: String
}
data SearchFile = SearchFile {
- searchFilePath :: FilePath
- searchFileFormat :: String
- searchFilePropFormat :: String
- searchFilePropVia :: Maybe String
}
data CommandSearchResults = CommandSearchResults {
- searchResultRequirements :: [RequirementInfo]
- searchResultDiagrams :: [DiagramInfo]
}
data RequirementInfo = RequirementInfo {
}
data DiagramInfo = DiagramInfo {
- diagramInfoLocation :: FilePath
}
type ErrorCode = Int

Documentation

command Source #

Arguments

:: CommandOptions	Customization options
-> IO (Maybe CommandSearchResults, Result ErrorCode)

Find elements in a project that meet a search query.

data CommandOptions Source #

Options used to customize the interpretation of input specifications.

Constructors

CommandOptions
Fields commandInputFiles :: [SearchFile] commandSearchQuery :: String

data SearchFile Source #

Information about one file in the command options.

Constructors

SearchFile
Fields searchFilePath :: FilePath searchFileFormat :: String searchFilePropFormat :: String searchFilePropVia :: Maybe String

data CommandSearchResults Source #

Lists of search results.

Constructors

CommandSearchResults
Fields searchResultRequirements :: [RequirementInfo] searchResultDiagrams :: [DiagramInfo]

Instances

Instances details

ToJSON CommandSearchResults Source #

Instance details

Defined in Command.Search

Methods

toJSON :: CommandSearchResults -> Value Source #

toEncoding :: CommandSearchResults -> Encoding Source #

toJSONList :: [CommandSearchResults] -> Value Source #

toEncodingList :: [CommandSearchResults] -> Encoding Source #

omitField :: CommandSearchResults -> Bool Source #

Generic CommandSearchResults Source #

Instance details

Defined in Command.Search

Associated Types

type Rep CommandSearchResults

Instance details

Defined in Command.Search

type Rep CommandSearchResults = D1 ('MetaData "CommandSearchResults" "Command.Search" "ogma-core-1.15.0-3hUeuqKaNPy9Y9bmZmPCXy" 'False) (C1 ('MetaCons "CommandSearchResults" 'PrefixI 'True) (S1 ('MetaSel ('Just "searchResultRequirements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [RequirementInfo]) :*: S1 ('MetaSel ('Just "searchResultDiagrams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [DiagramInfo])))

Methods

from :: CommandSearchResults -> Rep CommandSearchResults x Source #

to :: Rep CommandSearchResults x -> CommandSearchResults Source #

Show CommandSearchResults Source #

Instance details

Defined in Command.Search

Methods

showsPrec :: Int -> CommandSearchResults -> ShowS Source #

show :: CommandSearchResults -> String Source #

showList :: [CommandSearchResults] -> ShowS Source #

type Rep CommandSearchResults Source #

Instance details

Defined in Command.Search

type Rep CommandSearchResults = D1 ('MetaData "CommandSearchResults" "Command.Search" "ogma-core-1.15.0-3hUeuqKaNPy9Y9bmZmPCXy" 'False) (C1 ('MetaCons "CommandSearchResults" 'PrefixI 'True) (S1 ('MetaSel ('Just "searchResultRequirements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [RequirementInfo]) :*: S1 ('MetaSel ('Just "searchResultDiagrams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [DiagramInfo])))

data RequirementInfo Source #

Information about a requirement that matches the search query.

Constructors

RequirementInfo
Fields requirementInfoLocation :: FilePath requirementInfoName :: String requirementInfoDescription :: String

Instances

Instances details

ToJSON RequirementInfo Source #

Instance details

Defined in Command.Search

Methods

toJSON :: RequirementInfo -> Value Source #

toEncoding :: RequirementInfo -> Encoding Source #

toJSONList :: [RequirementInfo] -> Value Source #

toEncodingList :: [RequirementInfo] -> Encoding Source #

omitField :: RequirementInfo -> Bool Source #

Generic RequirementInfo Source #

Instance details

Defined in Command.Search

Associated Types

type Rep RequirementInfo

Instance details

Defined in Command.Search

type Rep RequirementInfo = D1 ('MetaData "RequirementInfo" "Command.Search" "ogma-core-1.15.0-3hUeuqKaNPy9Y9bmZmPCXy" 'False) (C1 ('MetaCons "RequirementInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "requirementInfoLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: (S1 ('MetaSel ('Just "requirementInfoName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "requirementInfoDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

Methods

from :: RequirementInfo -> Rep RequirementInfo x Source #

to :: Rep RequirementInfo x -> RequirementInfo Source #

Show RequirementInfo Source #

Instance details

Defined in Command.Search

Methods

showsPrec :: Int -> RequirementInfo -> ShowS Source #

show :: RequirementInfo -> String Source #

showList :: [RequirementInfo] -> ShowS Source #

type Rep RequirementInfo Source #

Instance details

Defined in Command.Search

type Rep RequirementInfo = D1 ('MetaData "RequirementInfo" "Command.Search" "ogma-core-1.15.0-3hUeuqKaNPy9Y9bmZmPCXy" 'False) (C1 ('MetaCons "RequirementInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "requirementInfoLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: (S1 ('MetaSel ('Just "requirementInfoName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "requirementInfoDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

data DiagramInfo Source #

Information about a diagram that matches the search query.

Constructors

DiagramInfo
Fields diagramInfoLocation :: FilePath

Instances

Instances details

ToJSON DiagramInfo Source #

Instance details

Defined in Command.Search

Methods

toJSON :: DiagramInfo -> Value Source #

toEncoding :: DiagramInfo -> Encoding Source #

toJSONList :: [DiagramInfo] -> Value Source #

toEncodingList :: [DiagramInfo] -> Encoding Source #

omitField :: DiagramInfo -> Bool Source #

Generic DiagramInfo Source #

Instance details

Defined in Command.Search

Associated Types

type Rep DiagramInfo
Instance details Defined in Command.Search type Rep DiagramInfo = D1 ('MetaData "DiagramInfo" "Command.Search" "ogma-core-1.15.0-3hUeuqKaNPy9Y9bmZmPCXy" 'False) (C1 ('MetaCons "DiagramInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "diagramInfoLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))

Methods

from :: DiagramInfo -> Rep DiagramInfo x Source #

to :: Rep DiagramInfo x -> DiagramInfo Source #

Show DiagramInfo Source #

Instance details

Defined in Command.Search

Methods

showsPrec :: Int -> DiagramInfo -> ShowS Source #

show :: DiagramInfo -> String Source #

showList :: [DiagramInfo] -> ShowS Source #

type Rep DiagramInfo Source #

Instance details

Defined in Command.Search

type Rep DiagramInfo = D1 ('MetaData "DiagramInfo" "Command.Search" "ogma-core-1.15.0-3hUeuqKaNPy9Y9bmZmPCXy" 'False) (C1 ('MetaCons "DiagramInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "diagramInfoLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))

type ErrorCode = Int Source #

Encoding of reasons why the command can fail.