-- Copyright (c) 2020, Shayne Fletcher. All rights reserved.
-- SPDX-License-Identifier: BSD-3-Clause.

{-# LANGUAGE CPP #-}
#include "ghclib_api.h"

module Language.Haskell.GhclibParserEx.GHC.Types.Name.Reader(
   occNameStr, rdrNameStr, isSpecial, unqual, fromQual, isSymbolRdrName
 )
where

#if defined (GHCLIB_API_HEAD) || defined (GHCLIB_API_900)
import GHC.Types.SrcLoc
import GHC.Types.Name
import GHC.Types.Name.Reader
#else
import SrcLoc
import RdrName
import OccName
import Name
#endif

-- These names may not seem natural here but they work out in
-- practice. The use of thse two functions is thoroughly ubiquitous.
occNameStr :: RdrName -> String; occNameStr :: RdrName -> String
occNameStr = OccName -> String
occNameString (OccName -> String) -> (RdrName -> OccName) -> RdrName -> String
forall b c a. (b -> c) -> (a -> b) -> a -> c
. RdrName -> OccName
rdrNameOcc
rdrNameStr :: Located RdrName -> String; rdrNameStr :: Located RdrName -> String
rdrNameStr = RdrName -> String
occNameStr (RdrName -> String)
-> (Located RdrName -> RdrName) -> Located RdrName -> String
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Located RdrName -> RdrName
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc

-- Builtin type or data constructors.
isSpecial :: Located RdrName -> Bool
isSpecial :: Located RdrName -> Bool
isSpecial (L SrcSpan
_ (Exact Name
n)) = Name -> Bool
isDataConName Name
n Bool -> Bool -> Bool
|| Name -> Bool
isTyConName Name
n
isSpecial Located RdrName
_ = Bool
False

-- Coerce qualified names to unqualified (by discarding the
-- qualifier).
unqual :: Located RdrName -> Located RdrName
unqual :: Located RdrName -> Located RdrName
unqual (L SrcSpan
loc (Qual ModuleName
_ OccName
n)) = SrcSpan -> RdrName -> Located RdrName
forall l e. l -> e -> GenLocated l e
L SrcSpan
loc (RdrName -> Located RdrName) -> RdrName -> Located RdrName
forall a b. (a -> b) -> a -> b
$ OccName -> RdrName
mkRdrUnqual OccName
n
unqual Located RdrName
x = Located RdrName
x

-- Extract the occ name from a qualified/unqualified reader name.
fromQual :: Located RdrName -> Maybe OccName
fromQual :: Located RdrName -> Maybe OccName
fromQual (L SrcSpan
_ (Qual ModuleName
_ OccName
x)) = OccName -> Maybe OccName
forall a. a -> Maybe a
Just OccName
x
fromQual (L SrcSpan
_ (Unqual OccName
x)) = OccName -> Maybe OccName
forall a. a -> Maybe a
Just OccName
x
fromQual Located RdrName
_ = Maybe OccName
forall a. Maybe a
Nothing

-- Test if the reader name is that of an operator (be it a data
-- constructor, variable or whatever).
isSymbolRdrName :: RdrName -> Bool
isSymbolRdrName :: RdrName -> Bool
isSymbolRdrName = OccName -> Bool
isSymOcc (OccName -> Bool) -> (RdrName -> OccName) -> RdrName -> Bool
forall b c a. (b -> c) -> (a -> b) -> a -> c
. RdrName -> OccName
rdrNameOcc