Emanote.Model.Link.Rel

Documentation

data Rel

A relation from one note to anywhere in the model.

Target will remain unresolved in the Rel, and can be resolved at a latter time (eg: during rendering).

Constructors

Rel

Fields

• _relFrom :: LMLRoute
• _relTo :: UnresolvedRelTarget
• _relCtx :: [Block]

  The relation context in LML

Instances

Show Rel

Defined in Emanote.Model.Link.Rel

Methods

showsPrec :: Int -> Rel -> ShowS

show :: Rel -> String

showList :: [Rel] -> ShowS

Eq Rel

Defined in Emanote.Model.Link.Rel

Methods

(==) :: Rel -> Rel -> Bool

(/=) :: Rel -> Rel -> Bool

Ord Rel

Defined in Emanote.Model.Link.Rel

Methods

compare :: Rel -> Rel -> Ordering

(<) :: Rel -> Rel -> Bool

(<=) :: Rel -> Rel -> Bool

(>) :: Rel -> Rel -> Bool

(>=) :: Rel -> Rel -> Bool

max :: Rel -> Rel -> Rel

min :: Rel -> Rel -> Rel

Indexable RelIxs Rel

Defined in Emanote.Model.Link.Rel

Methods

indices :: IxList RelIxs Rel

data UnresolvedRelTarget

A link target that has not been resolved (using model) yet.

Resolving this may or may not result in a resource in the model. The ADT constructors capture the different possible types of links the user is allowed to link to.

Constructors

URTWikiLink (WikiLinkType, WikiLink)

URTResource ModelRoute

URTVirtual VirtualRoute

Instances

ToJSON UnresolvedRelTarget

Defined in Emanote.Model.Link.Rel

Methods

toJSON :: UnresolvedRelTarget -> Value

toEncoding :: UnresolvedRelTarget -> Encoding

toJSONList :: [UnresolvedRelTarget] -> Value

toEncodingList :: [UnresolvedRelTarget] -> Encoding

Generic UnresolvedRelTarget

Defined in Emanote.Model.Link.Rel

Associated Types

type Rep UnresolvedRelTarget :: Type -> Type

Methods

from :: UnresolvedRelTarget -> Rep UnresolvedRelTarget x

to :: Rep UnresolvedRelTarget x -> UnresolvedRelTarget

Show UnresolvedRelTarget

Defined in Emanote.Model.Link.Rel

Methods

showsPrec :: Int -> UnresolvedRelTarget -> ShowS

show :: UnresolvedRelTarget -> String

showList :: [UnresolvedRelTarget] -> ShowS

Eq UnresolvedRelTarget

Defined in Emanote.Model.Link.Rel

Methods

(==) :: UnresolvedRelTarget -> UnresolvedRelTarget -> Bool

(/=) :: UnresolvedRelTarget -> UnresolvedRelTarget -> Bool

Ord UnresolvedRelTarget

Defined in Emanote.Model.Link.Rel

Methods

compare :: UnresolvedRelTarget -> UnresolvedRelTarget -> Ordering

(<) :: UnresolvedRelTarget -> UnresolvedRelTarget -> Bool

(<=) :: UnresolvedRelTarget -> UnresolvedRelTarget -> Bool

(>) :: UnresolvedRelTarget -> UnresolvedRelTarget -> Bool

(>=) :: UnresolvedRelTarget -> UnresolvedRelTarget -> Bool

max :: UnresolvedRelTarget -> UnresolvedRelTarget -> UnresolvedRelTarget

min :: UnresolvedRelTarget -> UnresolvedRelTarget -> UnresolvedRelTarget

Indexable RelIxs Rel

Defined in Emanote.Model.Link.Rel

Methods

indices :: IxList RelIxs Rel

type Rep UnresolvedRelTarget

Defined in Emanote.Model.Link.Rel

type Rep UnresolvedRelTarget = D1 ('MetaData "UnresolvedRelTarget" "Emanote.Model.Link.Rel" "emanote-1.0.2.0-inplace" 'False) (C1 ('MetaCons "URTWikiLink" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (WikiLinkType, WikiLink))) :+: (C1 ('MetaCons "URTResource" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModelRoute)) :+: C1 ('MetaCons "URTVirtual" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VirtualRoute))))

type RelIxs = '[LMLRoute, UnresolvedRelTarget]

type IxRel = IxSet RelIxs Rel

relTo :: Lens' Rel UnresolvedRelTarget

relFrom :: Lens' Rel LMLRoute

relCtx :: Lens' Rel [Block]

noteRels :: Note -> IxRel

unresolvedRelsTo :: ModelRoute -> [UnresolvedRelTarget]

parseUnresolvedRelTarget :: Maybe (R 'Folder) -> [(Text, Text)] -> Text -> Maybe (UnresolvedRelTarget, Maybe Anchor)

Parse a relative URL string for later resolution.

TODO: Need tests for this function.

relocateRelUrlUnder :: Maybe FilePath -> FilePath -> FilePath

normalizeIgnoringSymlinks :: FilePath -> FilePath

Like normalise but also normalises '..'

dropDotDot :: FilePath -> FilePath

data ResolvedRelTarget a

An UnresolvedRelTarget that has been resolved.

See Model.Link.Resolve for actual resolution logic.

Constructors

RRTMissing

RRTAmbiguous (NonEmpty a)

RRTFound a

Instances

Functor ResolvedRelTarget

Defined in Emanote.Model.Link.Rel

Methods

fmap :: (a -> b) -> ResolvedRelTarget a -> ResolvedRelTarget b

(<$) :: a -> ResolvedRelTarget b -> ResolvedRelTarget a

ToJSON a => ToJSON (ResolvedRelTarget a)

Defined in Emanote.Model.Link.Rel

Methods

toJSON :: ResolvedRelTarget a -> Value

toEncoding :: ResolvedRelTarget a -> Encoding

toJSONList :: [ResolvedRelTarget a] -> Value

toEncodingList :: [ResolvedRelTarget a] -> Encoding

Generic (ResolvedRelTarget a)

Defined in Emanote.Model.Link.Rel

Associated Types

type Rep (ResolvedRelTarget a) :: Type -> Type

Methods

from :: ResolvedRelTarget a -> Rep (ResolvedRelTarget a) x

to :: Rep (ResolvedRelTarget a) x -> ResolvedRelTarget a

Show a => Show (ResolvedRelTarget a)

Defined in Emanote.Model.Link.Rel

Methods

showsPrec :: Int -> ResolvedRelTarget a -> ShowS

show :: ResolvedRelTarget a -> String

showList :: [ResolvedRelTarget a] -> ShowS

Eq a => Eq (ResolvedRelTarget a)

Defined in Emanote.Model.Link.Rel

Methods

(==) :: ResolvedRelTarget a -> ResolvedRelTarget a -> Bool

(/=) :: ResolvedRelTarget a -> ResolvedRelTarget a -> Bool

Ord a => Ord (ResolvedRelTarget a)

Defined in Emanote.Model.Link.Rel

Methods

compare :: ResolvedRelTarget a -> ResolvedRelTarget a -> Ordering

(<) :: ResolvedRelTarget a -> ResolvedRelTarget a -> Bool

(<=) :: ResolvedRelTarget a -> ResolvedRelTarget a -> Bool

(>) :: ResolvedRelTarget a -> ResolvedRelTarget a -> Bool

(>=) :: ResolvedRelTarget a -> ResolvedRelTarget a -> Bool

max :: ResolvedRelTarget a -> ResolvedRelTarget a -> ResolvedRelTarget a

min :: ResolvedRelTarget a -> ResolvedRelTarget a -> ResolvedRelTarget a

type Rep (ResolvedRelTarget a)

Defined in Emanote.Model.Link.Rel

type Rep (ResolvedRelTarget a) = D1 ('MetaData "ResolvedRelTarget" "Emanote.Model.Link.Rel" "emanote-1.0.2.0-inplace" 'False) (C1 ('MetaCons "RRTMissing" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "RRTAmbiguous" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty a))) :+: C1 ('MetaCons "RRTFound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a))))

resolvedRelTargetFromCandidates :: [a] -> ResolvedRelTarget a