Header menu logo fantomas

SyntaxTreeOps Module

Types and nested modules

Type/Module Description

SynInfo

Operations related to the syntactic analysis of arguments of value, function and member definitions and signatures.

SynArgNameGenerator

Functions and values

Function or value Description

AbstractMemberFlags isInstance k

Full Usage: AbstractMemberFlags isInstance k

Parameters:
Returns: SynMemberFlags
isInstance : bool
k : SynMemberKind
Returns: SynMemberFlags

ClassCtorMemberFlags

Full Usage: ClassCtorMemberFlags

Returns: SynMemberFlags
Returns: SynMemberFlags

ConcatAttributesLists attrsLists

Full Usage: ConcatAttributesLists attrsLists

Parameters:
Returns: SynAttribute list
attrsLists : SynAttributeList list
Returns: SynAttribute list

CtorMemberFlags

Full Usage: CtorMemberFlags

Returns: SynMemberFlags
Returns: SynMemberFlags

ImplementStaticMemberFlags k

Full Usage: ImplementStaticMemberFlags k

Parameters:
Returns: SynMemberFlags
k : SynMemberKind
Returns: SynMemberFlags

IsControlFlowExpression e

Full Usage: IsControlFlowExpression e

Parameters:
Returns: bool

This affects placement of debug points

e : SynExpr
Returns: bool

IsDebugPointBinding synPat synExpr

Full Usage: IsDebugPointBinding synPat synExpr

Parameters:
Returns: bool
synPat : SynPat
synExpr : SynExpr
Returns: bool

NonVirtualMemberFlags k

Full Usage: NonVirtualMemberFlags k

Parameters:
Returns: SynMemberFlags
k : SynMemberKind
Returns: SynMemberFlags

OverrideMemberFlags k

Full Usage: OverrideMemberFlags k

Parameters:
Returns: SynMemberFlags
k : SynMemberKind
Returns: SynMemberFlags

PushCurriedPatternsToExpr synArgNameGenerator wholem isMember pats arrow rhs

Full Usage: PushCurriedPatternsToExpr synArgNameGenerator wholem isMember pats arrow rhs

Parameters:
Returns: SynSimplePats list * SynExpr
 "fun (UnionCase x) (UnionCase y) -> body"
       ==>
   "fun tmp1 tmp2 ->
        let (UnionCase x) = tmp1 in
        let (UnionCase y) = tmp2 in
        body"
synArgNameGenerator : SynArgNameGenerator
wholem : range
isMember : bool
pats : SynPat list
arrow : Range option
rhs : SynExpr
Returns: SynSimplePats list * SynExpr

PushPatternToExpr synArgNameGenerator isMember pat rhs

Full Usage: PushPatternToExpr synArgNameGenerator isMember pat rhs

Parameters:
Returns: SynSimplePats * SynExpr
synArgNameGenerator : SynArgNameGenerator
isMember : bool
pat : SynPat
rhs : SynExpr
Returns: SynSimplePats * SynExpr

SimplePatOfPat synArgNameGenerator p

Full Usage: SimplePatOfPat synArgNameGenerator p

Parameters:
Returns: SynSimplePat * (SynExpr -> SynExpr) option

Push non-simple parts of a patten match over onto the r.h.s. of a lambda. Return a simple pattern and a function to build a match on the r.h.s. if the pattern is complex

synArgNameGenerator : SynArgNameGenerator
p : SynPat
Returns: SynSimplePat * (SynExpr -> SynExpr) option

SimplePatsOfPat synArgNameGenerator p

Full Usage: SimplePatsOfPat synArgNameGenerator p

Parameters:
Returns: SynSimplePats * (SynExpr -> SynExpr) option
synArgNameGenerator : SynArgNameGenerator
p : SynPat
Returns: SynSimplePats * (SynExpr -> SynExpr) option

StaticMemberFlags k

Full Usage: StaticMemberFlags k

Parameters:
Returns: SynMemberFlags
k : SynMemberKind
Returns: SynMemberFlags

appFunOpt funOpt x

Full Usage: appFunOpt funOpt x

Parameters:
    funOpt : ('a -> 'a) option
    x : 'a

Returns: 'a
funOpt : ('a -> 'a) option
x : 'a
Returns: 'a

arbExpr (debugStr, range)

Full Usage: arbExpr (debugStr, range)

Parameters:
    debugStr : string
    range : range

Returns: SynExpr
debugStr : string
range : range
Returns: SynExpr

arrPathOfLid lid

Full Usage: arrPathOfLid lid

Parameters:
Returns: string[]
lid : Ident list
Returns: string[]

composeFunOpt funOpt1 funOpt2

Full Usage: composeFunOpt funOpt1 funOpt2

Parameters:
    funOpt1 : ('a -> 'a) option
    funOpt2 : ('a -> 'a) option

Returns: ('a -> 'a) option
funOpt1 : ('a -> 'a) option
funOpt2 : ('a -> 'a) option
Returns: ('a -> 'a) option

desugarGetSetMembers memberDefns

Full Usage: desugarGetSetMembers memberDefns

Parameters:
Returns: SynMemberDefns
memberDefns : SynMemberDefns
Returns: SynMemberDefns

getTypeFromTuplePath path

Full Usage: getTypeFromTuplePath path

Parameters:
Returns: SynType list
path : SynTupleTypeSegment list
Returns: SynType list

ident (s, r)

Full Usage: ident (s, r)

Parameters:
Returns: Ident
s : string
r : range
Returns: Ident

inferredTyparDecls

Full Usage: inferredTyparDecls

Returns: SynValTyparDecls
Returns: SynValTyparDecls

mkAttributeList attrs range

Full Usage: mkAttributeList attrs range

Parameters:
Returns: SynAttributeList list
attrs : SynAttribute list
range : range
Returns: SynAttributeList list

mkDynamicArgExpr expr

Full Usage: mkDynamicArgExpr expr

Parameters:
Returns: SynExpr
expr : SynExpr
Returns: SynExpr

mkSynAnonField (ty, xmlDoc)

Full Usage: mkSynAnonField (ty, xmlDoc)

Parameters:
Returns: SynField
ty : SynType
xmlDoc : PreXmlDoc
Returns: SynField

mkSynApp1 f x1 m

Full Usage: mkSynApp1 f x1 m

Parameters:
Returns: SynExpr
f : SynExpr
x1 : SynExpr
m : range
Returns: SynExpr

mkSynApp2 f x1 x2 m

Full Usage: mkSynApp2 f x1 x2 m

Parameters:
Returns: SynExpr
f : SynExpr
x1 : SynExpr
x2 : SynExpr
m : range
Returns: SynExpr

mkSynApp3 f x1 x2 x3 m

Full Usage: mkSynApp3 f x1 x2 x3 m

Parameters:
Returns: SynExpr
f : SynExpr
x1 : SynExpr
x2 : SynExpr
x3 : SynExpr
m : range
Returns: SynExpr

mkSynApp4 f x1 x2 x3 x4 m

Full Usage: mkSynApp4 f x1 x2 x3 x4 m

Parameters:
Returns: SynExpr
f : SynExpr
x1 : SynExpr
x2 : SynExpr
x3 : SynExpr
x4 : SynExpr
m : range
Returns: SynExpr

mkSynApp5 f x1 x2 x3 x4 x5 m

Full Usage: mkSynApp5 f x1 x2 x3 x4 x5 m

Parameters:
Returns: SynExpr
f : SynExpr
x1 : SynExpr
x2 : SynExpr
x3 : SynExpr
x4 : SynExpr
x5 : SynExpr
m : range
Returns: SynExpr

mkSynAssign l r

Full Usage: mkSynAssign l r

Parameters:
Returns: SynExpr
l : SynExpr
r : SynExpr
Returns: SynExpr

mkSynBifix m oper x1 x2

Full Usage: mkSynBifix m oper x1 x2

Parameters:
Returns: SynExpr
m : range
oper : string
x1 : SynExpr
x2 : SynExpr
Returns: SynExpr

mkSynBinding (xmlDoc, headPat) (vis, isInline, isMutable, mBind, spBind, retInfo, origRhsExpr, mRhs, staticOptimizations, attrs, memberFlagsOpt, trivia)

Full Usage: mkSynBinding (xmlDoc, headPat) (vis, isInline, isMutable, mBind, spBind, retInfo, origRhsExpr, mRhs, staticOptimizations, attrs, memberFlagsOpt, trivia)

Parameters:
Returns: SynBinding
xmlDoc : PreXmlDoc
headPat : SynPat
vis : SynAccess option
isInline : bool
isMutable : bool
mBind : range
spBind : DebugPointAtBinding
retInfo : (range option * SynReturnInfo) option
origRhsExpr : SynExpr
mRhs : range
staticOptimizations : (SynStaticOptimizationConstraint list * SynExpr) list
attrs : SynAttributes
memberFlagsOpt : SynMemberFlags option
trivia : SynBindingTrivia
Returns: SynBinding

mkSynBindingRhs staticOptimizations rhsExpr mRhs retInfo

Full Usage: mkSynBindingRhs staticOptimizations rhsExpr mRhs retInfo

Parameters:
Returns: SynExpr * SynBindingReturnInfo option
staticOptimizations : (SynStaticOptimizationConstraint list * SynExpr) list
rhsExpr : SynExpr
mRhs : range
retInfo : (range option * SynReturnInfo) option
Returns: SynExpr * SynBindingReturnInfo option

mkSynCaseName m n

Full Usage: mkSynCaseName m n

Parameters:
Returns: Ident list
m : range
n : string
Returns: Ident list

mkSynCompGenSimplePatVar id

Full Usage: mkSynCompGenSimplePatVar id

Parameters:
Returns: SynSimplePat
id : Ident
Returns: SynSimplePat

mkSynDelay m e

Full Usage: mkSynDelay m e

Parameters:
Returns: SynExpr
m : range
e : SynExpr
Returns: SynExpr

mkSynDot mDot m l r

Full Usage: mkSynDot mDot m l r

Parameters:
Returns: SynExpr
mDot : range
m : range
l : SynExpr
r : SynIdent
Returns: SynExpr

mkSynDotBrackGet m mDot a b

Full Usage: mkSynDotBrackGet m mDot a b

Parameters:
Returns: SynExpr
m : range
mDot : range
a : SynExpr
b : SynExpr
Returns: SynExpr

mkSynDotMissing mDot m expr

Full Usage: mkSynDotMissing mDot m expr

Parameters:
Returns: SynExpr
mDot : range
m : range
expr : SynExpr
Returns: SynExpr

mkSynDotParenGet mLhs mDot a b

Full Usage: mkSynDotParenGet mLhs mDot a b

Parameters:
Returns: SynExpr
mLhs : range
mDot : range
a : SynExpr
b : SynExpr
Returns: SynExpr

mkSynDotParenSet m a b c

Full Usage: mkSynDotParenSet m a b c

Parameters:
Returns: SynExpr
m : range
a : SynExpr
b : SynExpr
c : SynExpr
Returns: SynExpr

mkSynFunMatchLambdas synArgNameGenerator isMember wholem ps arrow e

Full Usage: mkSynFunMatchLambdas synArgNameGenerator isMember wholem ps arrow e

Parameters:
Returns: SynExpr
synArgNameGenerator : SynArgNameGenerator
isMember : bool
wholem : range
ps : SynPat list
arrow : Range option
e : SynExpr
Returns: SynExpr

mkSynId m s

Full Usage: mkSynId m s

Parameters:
Returns: Ident
m : range
s : string
Returns: Ident

mkSynIdGet m n

Full Usage: mkSynIdGet m n

Parameters:
Returns: SynExpr
m : range
n : string
Returns: SynExpr

mkSynIdGetWithAlt m id altInfo

Full Usage: mkSynIdGetWithAlt m id altInfo

Parameters:
Returns: SynExpr
m : range
id : Ident
altInfo : SynSimplePatAlternativeIdInfo ref option
Returns: SynExpr

mkSynInfix opm l oper r

Full Usage: mkSynInfix opm l oper r

Parameters:
Returns: SynExpr
opm : range
l : SynExpr
oper : string
r : SynExpr
Returns: SynExpr

mkSynLidGet m path n

Full Usage: mkSynLidGet m path n

Parameters:
    m : range
    path : string list
    n : string

Returns: SynExpr
m : range
path : string list
n : string
Returns: SynExpr

mkSynNamedField (ident, ty, xmlDoc, m)

Full Usage: mkSynNamedField (ident, ty, xmlDoc, m)

Parameters:
Returns: SynField
ident : Ident
ty : SynType
xmlDoc : PreXmlDoc
m : range
Returns: SynField

mkSynOperator opm oper

Full Usage: mkSynOperator opm oper

Parameters:
    opm : range
    oper : string

Returns: SynExpr
opm : range
oper : string
Returns: SynExpr

mkSynPatMaybeVar lidwd vis m

Full Usage: mkSynPatMaybeVar lidwd vis m

Parameters:
Returns: SynPat
lidwd : SynLongIdent
vis : SynAccess option
m : range
Returns: SynPat

mkSynPatVar vis id

Full Usage: mkSynPatVar vis id

Parameters:
Returns: SynPat
vis : SynAccess option
id : Ident
Returns: SynPat

mkSynPrefix opm m oper x

Full Usage: mkSynPrefix opm m oper x

Parameters:
Returns: SynExpr
opm : range
m : range
oper : string
x : SynExpr
Returns: SynExpr

mkSynPrefixPrim opm m oper x

Full Usage: mkSynPrefixPrim opm m oper x

Parameters:
Returns: SynExpr
opm : range
m : range
oper : string
x : SynExpr
Returns: SynExpr

mkSynQMarkSet m a b c

Full Usage: mkSynQMarkSet m a b c

Parameters:
Returns: SynExpr
m : range
a : SynExpr
b : SynExpr
c : SynExpr
Returns: SynExpr

mkSynSimplePatVar isOpt id

Full Usage: mkSynSimplePatVar isOpt id

Parameters:
    isOpt : bool
    id : Ident

Returns: SynSimplePat
isOpt : bool
id : Ident
Returns: SynSimplePat

mkSynThisPatVar id

Full Usage: mkSynThisPatVar id

Parameters:
Returns: SynPat
id : Ident
Returns: SynPat

mkSynTrifix m oper x1 x2 x3

Full Usage: mkSynTrifix m oper x1 x2 x3

Parameters:
Returns: SynExpr
m : range
oper : string
x1 : SynExpr
x2 : SynExpr
x3 : SynExpr
Returns: SynExpr

mkSynUnit m

Full Usage: mkSynUnit m

Parameters:
Returns: SynExpr
m : range
Returns: SynExpr

mkSynUnitPat m

Full Usage: mkSynUnitPat m

Parameters:
Returns: SynPat
m : range
Returns: SynPat

noInferredTypars

Full Usage: noInferredTypars

Returns: SynValTyparDecls
Returns: SynValTyparDecls

normalizeTuplePat pats commas

Full Usage: normalizeTuplePat pats commas

Parameters:
Returns: SynPat list * List<range>
pats : SynPat list
commas : range list
Returns: SynPat list * List<range>

opNameParenGet

Full Usage: opNameParenGet

Returns: string
Returns: string

opNameQMark

Full Usage: opNameQMark

Returns: string
Returns: string

pathOfLid lid

Full Usage: pathOfLid lid

Parameters:
Returns: string list
lid : Ident list
Returns: string list

pathToSynLid m p

Full Usage: pathToSynLid m p

Parameters:
    m : range
    p : string list

Returns: Ident list
m : range
p : string list
Returns: Ident list

prependIdentInLongIdentWithTrivia ident mDot lid

Full Usage: prependIdentInLongIdentWithTrivia ident mDot lid

Parameters:
Returns: SynLongIdent
ident : SynIdent
mDot : range
lid : SynLongIdent
Returns: SynLongIdent

pushUnaryArg expr arg

Full Usage: pushUnaryArg expr arg

Parameters:
Returns: SynExpr
expr : SynExpr
arg : Ident
Returns: SynExpr

rangeOfLid lid

Full Usage: rangeOfLid lid

Parameters:
Returns: range
lid : Ident list
Returns: range

rangeOfNonNilAttrs attrs

Full Usage: rangeOfNonNilAttrs attrs

Parameters:
Returns: range
attrs : SynAttributes
Returns: range

stripParenTypes synType

Full Usage: stripParenTypes synType

Parameters:
Returns: SynType
synType : SynType
Returns: SynType

synExprContainsError inpExpr

Full Usage: synExprContainsError inpExpr

Parameters:
Returns: bool
inpExpr : SynExpr
Returns: bool

textOfId id

Full Usage: textOfId id

Parameters:
Returns: string
id : Ident
Returns: string

textOfLid lid

Full Usage: textOfLid lid

Parameters:
Returns: string
lid : Ident list
Returns: string

textOfPath path

Full Usage: textOfPath path

Parameters:
    path : string seq

Returns: string
path : string seq
Returns: string

unionBindingAndMembers bindings members

Full Usage: unionBindingAndMembers bindings members

Parameters:
Returns: SynBinding list
bindings : SynBinding list
members : SynMemberDefn list
Returns: SynBinding list

unionRangeWithListBy projectRangeFromThing m listOfThing

Full Usage: unionRangeWithListBy projectRangeFromThing m listOfThing

Parameters:
    projectRangeFromThing : 'a -> range
    m : range
    listOfThing : 'a list

Returns: range
projectRangeFromThing : 'a -> range
m : range
listOfThing : 'a list
Returns: range

unionRangeWithXmlDoc xmlDoc range

Full Usage: unionRangeWithXmlDoc xmlDoc range

Parameters:
Returns: range
Modifiers: inline
xmlDoc : PreXmlDoc
range : range
Returns: range

Active patterns

Active pattern Description

(|Attributes|) synAttributes

Full Usage: (|Attributes|) synAttributes

Parameters:
Returns: SynAttribute list
synAttributes : SynAttributeList list
Returns: SynAttribute list

(|Get_OrSet_Ident|_|) arg1

Full Usage: (|Get_OrSet_Ident|_|) arg1

Parameters:
Returns: unit voption

Generated get_XYZ or set_XYZ ident text

arg0 : Ident
Returns: unit voption

(|LongOrSingleIdent|_|) inp

Full Usage: (|LongOrSingleIdent|_|) inp

Parameters:
Returns: (bool * SynLongIdent * SynSimplePatAlternativeIdInfo ref option * range) voption

Match a long identifier, including the case for single identifiers which gets a more optimized node in the syntax tree.

inp : SynExpr
Returns: (bool * SynLongIdent * SynSimplePatAlternativeIdInfo ref option * range) voption

(|MultiDimensionArrayType|_|) t

Full Usage: (|MultiDimensionArrayType|_|) t

Parameters:
Returns: (int * SynType * range) voption
t : SynType
Returns: (int * SynType * range) voption

(|ParsedHashDirectiveArguments|) arg1

Full Usage: (|ParsedHashDirectiveArguments|) arg1

Parameters:
Returns: string list
arg0 : ParsedHashDirectiveArgument list
Returns: string list

(|SingleIdent|_|) inp

Full Usage: (|SingleIdent|_|) inp

Parameters:
Returns: Ident voption
inp : SynExpr
Returns: Ident voption

(|StripParenTypes|) synType

Full Usage: (|StripParenTypes|) synType

Parameters:
Returns: SynType
synType : SynType
Returns: SynType

(|SynAndAlso|_|) arg1

Full Usage: (|SynAndAlso|_|) arg1

Parameters:
Returns: (SynExpr * SynExpr) voption

'e1 && e2'

arg0 : SynExpr
Returns: (SynExpr * SynExpr) voption

(|SynExprErrorSkip|) p

Full Usage: (|SynExprErrorSkip|) p

Parameters:
Returns: SynExpr
p : SynExpr
Returns: SynExpr

(|SynExprParen|_|) e

Full Usage: (|SynExprParen|_|) e

Parameters:
Returns: (SynExpr * range * range option * range) voption
e : SynExpr
Returns: (SynExpr * range * range option * range) voption

(|SynOrElse|_|) arg1

Full Usage: (|SynOrElse|_|) arg1

Parameters:
Returns: (SynExpr * SynExpr) voption

'e1 || e2'

arg0 : SynExpr
Returns: (SynExpr * SynExpr) voption

(|SynPatErrorSkip|) p

Full Usage: (|SynPatErrorSkip|) p

Parameters:
Returns: SynPat
p : SynPat
Returns: SynPat

(|SynPatForConstructorDecl|_|) x

Full Usage: (|SynPatForConstructorDecl|_|) x

Parameters:
Returns: SynPat voption
x : SynPat
Returns: SynPat voption

(|SynPatForNullaryArgs|_|) x

Full Usage: (|SynPatForNullaryArgs|_|) x

Parameters:
Returns: unit voption

Recognize the '()' in 'new()'

x : SynPat
Returns: unit voption

(|SynPipeRight2|_|) arg1

Full Usage: (|SynPipeRight2|_|) arg1

Parameters:
Returns: (SynExpr * SynExpr * SynExpr) voption

'e1 ||> e2'

arg0 : SynExpr
Returns: (SynExpr * SynExpr * SynExpr) voption

(|SynPipeRight3|_|) arg1

Full Usage: (|SynPipeRight3|_|) arg1

Parameters:
Returns: (SynExpr * SynExpr * SynExpr * SynExpr) voption

'e1 |||> e2'

arg0 : SynExpr
Returns: (SynExpr * SynExpr * SynExpr * SynExpr) voption

(|SynPipeRight|_|) arg1

Full Usage: (|SynPipeRight|_|) arg1

Parameters:
Returns: (SynExpr * SynExpr) voption

'e1 |> e2'

arg0 : SynExpr
Returns: (SynExpr * SynExpr) voption

(|TyparDecls|) typarDecls

Full Usage: (|TyparDecls|) typarDecls

Parameters:
Returns: SynTyparDecl list
typarDecls : SynTyparDecls option
Returns: SynTyparDecl list

(|TyparsAndConstraints|) typarDecls

Full Usage: (|TyparsAndConstraints|) typarDecls

Parameters:
Returns: SynTyparDecl list * SynTypeConstraint list
typarDecls : SynTyparDecls option
Returns: SynTyparDecl list * SynTypeConstraint list

(|TypesForTypar|) t

Full Usage: (|TypesForTypar|) t

Parameters:
Returns: SynType list
t : SynType
Returns: SynType list

(|ValTyparDecls|) valTyparDecls

Full Usage: (|ValTyparDecls|) valTyparDecls

Parameters:
Returns: SynTyparDecl list * SynTypeConstraint list * bool
valTyparDecls : SynValTyparDecls
Returns: SynTyparDecl list * SynTypeConstraint list * bool

Type something to start searching.