Merge branch 'master' into php-strict-equal-assignment

Author: Patrick Thomson

.gitattributes

@@ -2,3 +2,4 @@
 test/fixtures linguist-vendored
 test/repos linguist-vendored
 vendor linguist-vendored
+*.protobuf.bin binary

.hlint.yaml

@@ -67,7 +67,7 @@
 # Conveniences
 - warning: {lhs: maybe a pure, rhs: maybeM a, name: Use maybeM}
 - warning: {lhs: either (const a) id, rhs: fromRight a, name: use fromRight}
-- warning: {lhs: either id (const a), rhs: fromLeft a, name: use fromRight}
+- warning: {lhs: either id (const a), rhs: fromLeft a, name: use fromLeft}
 
 # Applicative style
 - warning: {lhs: f <$> pure a <*> b, rhs: f a <$> b, name: Avoid redundant pure}

.travis.yml

@@ -37,6 +37,7 @@ script:
 - cabal new-build
 - cabal new-run semantic:test
 - cabal new-run semantic-core:spec
+- cabal new-run semantic-core:doctest
 # parse-examples is disabled because it slaughters our CI
 # - cabal new-run semantic:parse-examples
 

CONTRIBUTING.md

@@ -7,6 +7,8 @@
 
 Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
 
+We're happy to accept code and documentation contributions, as well as issues suggesting new features, asking questions about how things work, or generally about what we're trying to accomplish! However, we are not opening up the code review process to the public. PRs should _only_ be reviewed by one of the project maintainers. Therefore, we ask that you refrain from leaving approvals or change requests on in-progress pull requests, as spurious reviews make it difficult to discern which patches are truly ready for integration.
+
 Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.md).
 
 Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
@@ -28,6 +30,8 @@ Here are a few things you can do that will increase the likelihood of your pull
 - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
 - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
 
+Unless you are a member of the Semantic team or a code owner, we ask that you refrain from leaving approvals or change requests on in-progress pull requests, as spurious reviews make it difficult to discern which patches are truly ready for integration.
+
 Please be aware that contributions to Semantic may multiple cycles of code review—we are grateful for all community involvement, but because Semantic powers real systems, we must maintain a high standard of code quality. For reasons of compatibility with production uses of Semantic within GitHub, we may also reject or require modifications to changes that would affect these systems. We may also reject patches that don't fit with our vision of the project; should this be the case, we will be clear about our rationale.
 
 ## Resources

README.md

@@ -96,19 +96,20 @@ Available options:
 
 ## Development
 
+`semantic` requires at least GHC 8.6.4 and Cabal 2.4. We strongly recommend using [`ghcup`][ghcup] to sandbox GHC versions, as GHC packages installed through your OS's package manager may not install statically-linked versions of the GHC boot libraries.
+
 We use `cabal's` [Nix-style local builds][nix] for development. To get started quickly:
 
 ```bash
 git clone git@github.com:github/semantic.git
 cd semantic
-git submodule sync --recursive && git submodule update --init --recursive --force
-cabal new-update
+script/bootstrap
 cabal new-build
 cabal new-test
 cabal new-run semantic -- --help
 ```
 
-`semantic` requires at least GHC 8.6.4 and Cabal 2.4. We recommend using [`ghcup`][ghcup] to sandbox GHC versions. `stack` as a build tool is not officially supported; there is an unofficial [`stack.yaml`](https://gist.github.com/jkachmar/f200caee83280f1f25e9cfa2dd2b16bb) available, though we cannot make guarantees as to its stability.
+ `stack` as a build tool is not officially supported; there is an unofficial [`stack.yaml`](https://gist.github.com/jkachmar/f200caee83280f1f25e9cfa2dd2b16bb) available, though we cannot make guarantees as to its stability.
 
 [nix]: https://www.haskell.org/cabal/users-guide/nix-local-build-overview.html
 [stackage]: https://stackage.org

cabal.project

@@ -1,4 +1,4 @@
-packages: . semantic-core
+packages: . semantic-core semantic-python
 
 jobs: $ncpus
 

script/bootstrap

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+git submodule sync --recursive && git submodule update --init --recursive --force
+cabal new-update

semantic-core/semantic-core.cabal

@@ -3,16 +3,17 @@ cabal-version:       2.4
 name:                semantic-core
 version:             0.0.0.0
 synopsis:            Semantic core intermediate language
--- description:
-homepage:            https://github.com/github/semantic-core
--- bug-reports:
+description:         Core intermediate language for program analysis using abstract definitional interpretation.
+homepage:            https://github.com/github/semantic/tree/master/semantic-core#readme
+bug-reports:         https://github.com/github/semantic/issues
 license:             MIT
 license-file:        LICENSE
-author:              Rob Rix
-maintainer:          robrix@github.com
--- copyright:
+author:              The Semantic authors
+maintainer:          opensource+semantic@github.com
+copyright:           (c) 2019 GitHub, Inc.
 category:            Language
 build-type:          Simple
+stability:           alpha
 extra-source-files:  README.md
 
 tested-with:         GHC == 8.6.4
@@ -46,14 +47,24 @@ library
                      , prettyprinter-ansi-terminal ^>= 1.1.1
                      , recursion-schemes           ^>= 5.1
                      , semigroupoids               ^>= 5.3
+                     , text                        ^>= 1.2.3.1
                      , transformers                ^>= 0.5.6
                      , trifecta                    ^>= 2
                      , unordered-containers        ^>= 0.2.10
   hs-source-dirs:      src
   default-language:    Haskell2010
-  ghc-options:         -Weverything -Wno-missing-local-signatures -Wno-missing-import-lists -Wno-implicit-prelude -Wno-safe -Wno-unsafe -Wno-name-shadowing -Wno-monomorphism-restriction -Wno-missed-specialisations -Wno-all-missed-specialisations
-  if (impl(ghc >= 8.6))
-    ghc-options:       -Wno-star-is-type
+  ghc-options:
+    -Weverything
+    -Wno-missing-local-signatures
+    -Wno-missing-import-lists
+    -Wno-implicit-prelude
+    -Wno-safe
+    -Wno-unsafe
+    -Wno-name-shadowing
+    -Wno-monomorphism-restriction
+    -Wno-missed-specialisations
+    -Wno-all-missed-specialisations
+    -Wno-star-is-type
 
 test-suite doctest
   type:                exitcode-stdio-1.0

semantic-core/src/Analysis/Concrete.hs

@@ -1,4 +1,4 @@
-{-# LANGUAGE FlexibleContexts, FlexibleInstances, GeneralizedNewtypeDeriving, LambdaCase, MultiParamTypeClasses, NamedFieldPuns, RecordWildCards, TypeApplications, TypeOperators, UndecidableInstances #-}
+{-# LANGUAGE FlexibleContexts, FlexibleInstances, LambdaCase, MultiParamTypeClasses, NamedFieldPuns, OverloadedStrings, RecordWildCards, TypeOperators, UndecidableInstances #-}
 module Analysis.Concrete
 ( Concrete(..)
 , concrete
@@ -29,6 +29,7 @@ import           Data.Loc
 import qualified Data.Map as Map
 import           Data.Monoid (Alt(..))
 import           Data.Name
+import           Data.Text (Text, pack)
 import           Prelude hiding (fail)
 
 type Precise = Int
@@ -41,7 +42,7 @@ data Concrete
   = Closure Loc Name Core.Core Precise
   | Unit
   | Bool Bool
-  | String String
+  | String Text
   | Obj Frame
   deriving (Eq, Ord, Show)
 
@@ -60,7 +61,7 @@ type Heap = IntMap.IntMap Concrete
 
 -- | Concrete evaluation of a term to a value.
 --
---   >>> snd (concrete [File (Loc "bool" emptySpan) (Core.Bool True)])
+--   >>> map fileBody (snd (concrete [File (Loc "bool" emptySpan) (Core.Bool True)]))
 --   [Right (Bool True)]
 concrete :: [File Core.Core] -> (Heap, [File (Either (Loc, String) Concrete)])
 concrete
@@ -184,28 +185,32 @@ heapValueGraph h = heapGraph (const id) (const fromAddr) h
 heapAddressGraph :: Heap -> G.Graph (EdgeType, Precise)
 heapAddressGraph = heapGraph (\ addr v -> (Value v, addr)) (fmap G.vertex . (,) . either Edge Slot)
 
-addressStyle :: Heap -> G.Style (EdgeType, Precise) String
+addressStyle :: Heap -> G.Style (EdgeType, Precise) Text
 addressStyle heap = (G.defaultStyle vertex) { G.edgeAttributes }
-  where vertex (_, addr) = maybe (show addr <> " = ?") (((show addr <> " = ") <>) . fromConcrete) (IntMap.lookup addr heap)
+  where vertex (_, addr) = pack (show addr) <> " = " <> maybe "?" fromConcrete (IntMap.lookup addr heap)
         edgeAttributes _ (Slot name,         _) = ["label" G.:= fromName name]
         edgeAttributes _ (Edge Core.Import,  _) = ["color" G.:= "blue"]
         edgeAttributes _ (Edge Core.Lexical, _) = ["color" G.:= "green"]
         edgeAttributes _ _                      = []
         fromConcrete = \case
           Unit ->  "()"
-          Bool b -> show b
-          String s -> show s
+          Bool b -> pack $ show b
+          String s -> pack $ show s
           Closure (Loc p (Span s e)) n _ _ -> "\\\\ " <> fromName n <> " [" <> p <> ":" <> showPos s <> "-" <> showPos e <> "]"
           Obj _ -> "{}"
-        showPos (Pos l c) = show l <> ":" <> show c
+        showPos (Pos l c) = pack (show l) <> ":" <> pack (show c)
         fromName (User s)  = s
         fromName (Gen sym) = fromGensym sym
-        fromName (Path p)  = show p
+        fromName (Path p)  = pack $ show p
         fromGensym (Root s) = s
-        fromGensym (ss :/ (s, i)) = fromGensym ss <> "." <> s <> show i
+        fromGensym (ss :/ (s, i)) = fromGensym ss <> "." <> s <> pack (show i)
 
 data EdgeType
   = Edge Core.Edge
   | Slot Name
   | Value Concrete
   deriving (Eq, Ord, Show)
+
+
+-- $setup
+-- >>> :seti -XOverloadedStrings

semantic-core/src/Analysis/Eval.hs

@@ -1,4 +1,4 @@
-{-# LANGUAGE FlexibleContexts, GeneralizedNewtypeDeriving, LambdaCase, RankNTypes, RecordWildCards #-}
+{-# LANGUAGE FlexibleContexts, LambdaCase, OverloadedStrings, RankNTypes, RecordWildCards #-}
 module Analysis.Eval
 ( eval
 , prog1
@@ -21,6 +21,7 @@ import Data.Functor
 import Data.Loc
 import Data.Maybe (fromJust)
 import Data.Name
+import Data.Text (Text)
 import GHC.Stack
 import Prelude hiding (fail)
 
@@ -207,8 +208,8 @@ data Analysis address value m = Analysis
   , unit        :: m value
   , bool        :: Bool -> m value
   , asBool      :: value -> m Bool
-  , string      :: String -> m value -- FIXME: Text
-  , asString    :: value -> m String
+  , string      :: Text -> m value
+  , asString    :: value -> m Text
   , frame       :: m value
   , edge        :: Edge -> address -> m ()
   , (...)       :: forall a . address -> m a -> m a