Add basic code for profiling laziness

.Rbuildignore

@@ -0,0 +1,2 @@
+^LICENSE\.md$
+^\.clang-format

.clang-format

@@ -0,0 +1,103 @@
+---
+Language:        Cpp
+# BasedOnStyle:  LLVM
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Left
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: Yes
+BinPackArguments: false
+BinPackParameters: false
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterClass:            false
+  AfterControlStatement: false
+  AfterEnum:             false
+  AfterFunction:         false
+  AfterNamespace:        false
+  AfterObjCDeclaration:  false
+  AfterStruct:           false
+  AfterUnion:            false
+  AfterExternBlock:      false
+  BeforeCatch:           false
+  BeforeElse:            false
+  IndentBraces:          false
+  SplitEmptyFunction:    true
+  SplitEmptyRecord:      true
+  SplitEmptyNamespace:   true
+BreakBeforeBinaryOperators: None
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeComma
+BreakInheritanceList: BeforeComma
+BreakStringLiterals: true
+ColumnLimit:     80
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat:   false
+FixNamespaceComments: true
+ForEachMacros:   [ foreach, Q_FOREACH, BOOST_FOREACH ]
+IncludeBlocks: Regroup
+IncludeCategories:
+  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority:        2
+  - Regex:           '^(<|"(gtest|isl|json)/)'
+    Priority:        3
+  - Regex:           '.*'
+    Priority:        1
+IndentCaseLabels: false
+IndentPPDirectives: AfterHash
+IndentWidth: 4
+IndentWrappedFunctionNames: false
+KeepEmptyLinesAtTheStartOfBlocks: false
+Language: Cpp
+MacroBlockBegin: ''
+MacroBlockEnd: ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Left
+ReflowComments: true
+SortIncludes: false
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: true
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: false
+SpaceBeforeInheritanceColon: false
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInContainerLiterals: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Cpp11
+TabWidth:        8
+UseTab:          Never
+...

.gitignore

@@ -0,0 +1,92 @@
+################################################################################
+## R gitignore
+## https://raw.githubusercontent.com/github/gitignore/master/R.gitignore
+################################################################################
+# History files
+.Rhistory
+.Rapp.history
+
+# Session Data files
+.RData
+
+# User-specific files
+.Ruserdata
+
+# Example code in package build process
+*-Ex.R
+
+# Output files from R CMD build
+/*.tar.gz
+
+# Output files from R CMD check
+/*.Rcheck/
+
+# RStudio files
+.Rproj.user/
+
+# produced vignettes
+vignettes/*.html
+vignettes/*.pdf
+
+# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
+.httr-oauth
+
+# knitr and R markdown default cache directories
+*_cache/
+/cache/
+
+# Temporary files created by R markdown
+*.utf8.md
+*.knit.md
+
+# R Environment Variables
+.Renviron
+
+# pkgdown site
+docs/
+
+# translation temp files
+po/*~
+
+################################################################################
+## C++ gitignore
+## https://raw.githubusercontent.com/github/gitignore/master/C%2B%2B.gitignore
+################################################################################
+
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+################################################################################
+## Custom gitignore
+################################################################################
+/inst/run

DESCRIPTION

@@ -0,0 +1,26 @@
+Package: strictr
+Title: Strictness Analysis for R
+Version: 0.0.0.9000
+Authors@R: 
+    person(given = "Aviral",
+           family = "Goel",
+           role = c("aut", "cre"),
+           email = "[email protected]",
+           comment = c(ORCID = "0000-0002-0814-5015"))
+Description: This package generates laziness signatures for R functions
+             from dynamically generated traces.
+License: MIT + file LICENSE
+Encoding: UTF-8
+LazyData: true
+Imports:
+    instrumentr,
+    fst,
+    purrr
+Remotes:
+    PRL-PRG/instrumentr
+LinkingTo:
+    instrumentr
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.1.1
+Suggests: 
+    testthat

LICENSE

@@ -0,0 +1,2 @@
+YEAR: 2020
+COPYRIGHT HOLDER: Aviral Goel

LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2020 Aviral Goel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,28 @@
+R = R
+
+.PHONY: all build check document test
+
+all: document build check
+
+build: document
+	$(R) CMD build .
+
+check: build
+	$(R) CMD check strictr*tar.gz
+
+clean:
+	-rm -f strictr*tar.gz
+	-rm -fr strictr.Rcheck
+	-rm -rf src/*.o src/*.so
+
+document:
+	$(R) -e 'devtools::document()'
+
+test:
+	$(R) -e 'devtools::test()'
+
+lintr:
+	$(R) --slave -e "lintr::lint_package()"
+
+install: clean
+	$(R) CMD INSTALL .

NAMESPACE

@@ -0,0 +1,12 @@
+# Generated by roxygen2: do not edit by hand
+
+export(trace_strictness)
+export(write_tracing_data)
+importFrom(fst,write_fst)
+importFrom(instrumentr,get_data)
+importFrom(instrumentr,get_exec_stats)
+importFrom(instrumentr,trace_code)
+importFrom(instrumentr,trace_packages)
+importFrom(purrr,imap_chr)
+importFrom(utils,installed.packages)
+useDynLib(strictr, .registration = TRUE, .fixes = "C_")

R/data.R

@@ -0,0 +1,17 @@
+
+#' @importFrom instrumentr get_data
+get_tracing_state <- function(tracer) {
+    .Call(C_strictr_tracer_get_tracing_state, tracer)
+}
+
+#' @export
+#' @importFrom purrr imap_chr
+#' @importFrom fst write_fst
+write_tracing_data <- function(data, dirpath = getwd()) {
+    writer <- function(df, filename) {
+        filepath <- file.path(dirpath, paste0(filename, ".fst"))
+        write_fst(df, filepath)
+        filepath
+    }
+    imap_chr(data, writer)
+}

R/strictr.R

@@ -0,0 +1,4 @@
+## usethis namespace: start
+#' @useDynLib strictr, .registration = TRUE, .fixes = "C_"
+## usethis namespace: end
+NULL

R/tracer.R

@@ -0,0 +1,32 @@
+
+#' @importFrom instrumentr trace_packages
+create_strictness_tracer <- function(packages) {
+    exclusions <- c("base", "injectr", "strictr")
+
+    tracer <- .Call(C_strictr_tracer_create)
+
+    trace_packages(tracer, setdiff(packages, exclusions))
+
+    tracer
+}
+
+#' @export
+#' @importFrom instrumentr trace_code get_exec_stats
+trace_strictness <- function(code,
+                             environment = parent.frame(),
+                             quote = TRUE,
+                             packages = get_installed_packages()) {
+    tracer <- create_strictness_tracer(packages)
+
+    if(quote) {
+        code <- substitute(code)
+    }
+
+    trace_code(tracer, code, environment = environment, quote = FALSE)
+
+    state <- .Call(C_strictr_tracer_get_tracing_state, tracer)
+
+    state$exec_stats <- get_exec_stats(tracer)
+
+    state
+}

R/utilities.R

@@ -0,0 +1,19 @@
+
+hash_table <- function(...) {
+    object <- list2env(list(...), parent = emptyenv())
+    structure(object, class = c("hash_table", class(object)))
+}
+
+#' @importFrom utils installed.packages
+get_installed_packages <- function() {
+    unname(installed.packages()[, 1])
+}
+
+
+to_data_frame <- function(object) {
+    UseMethod("to_data_frame")
+}
+
+to_data_frame.hash_table <- function(object) {
+    do.call(rbind, as.list(object))
+}

README.md

@@ -0,0 +1,28 @@
+
+# strictr
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+The goal of strictr is to analyze function strictness.
+
+## Installation
+
+You can install the released version of strictr from [CRAN](https://CRAN.R-project.org) with:
+
+``` r
+install.packages("strictr")
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+``` r
+library(strictr)
+
+trace_strictness({
+    library(stringr)
+    str_c("a")
+})
+```