nasl 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+# Ruby gems files.
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+# Generated files.
+*.rex.rb
+*.tab.rb

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in nasl.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test*.rb']
+  t.verbose = true
+end

data/bin/nasl-parse

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+################################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'nasl'
+
+Nasl::Cli.run

data/lib/nasl/cli.rb

@@ -0,0 +1,94 @@
+################################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+require 'optparse'
+
+module Nasl
+  class Cli
+    @@Iterations = 1000
+
+    def self.run
+      cfg = {
+        :iterations => @@Iterations,
+        :verbose    => 0
+      }
+
+      Command.initialize!
+
+      optparse = OptionParser.new do |opts|
+        opts.banner = "Usage: nasl [options] [command [args]]"
+
+        opts.on('-i', '--iterations=ITERS', 'Benchmarking iterations') do |iters|
+          cfg[:iterations] = iters.to_i || @@Iterations
+        end
+
+        opts.on('-v', '--verbose', 'Output more information') do
+          cfg[:verbose] += 1
+        end
+      end
+
+      optparse.parse!
+
+      # Sanity check the command line arguments.
+      if ARGV.empty?
+        puts "No command was specified."
+        puts
+        usage
+        exit 1
+      end
+
+      cmd = ARGV.shift
+      cls = Command.find(cmd)
+      if cls.nil? then
+        puts "Command '#{cmd}' not supported."
+        puts
+        usage
+        exit 1
+      end
+
+      # Run the command.
+      cls.run(cfg, ARGV)
+    end
+
+    def self.usage
+      puts "For the moment, you have to run nasl-parse from its top-level directory."
+      puts
+      puts "./bin/nasl-parse [flags] [command] [path ...]"
+      puts
+      puts "Flags:"
+      puts "    -i iters    Benchmark the parser running 'iters' iterations, default #@@Iterations."
+      puts "                Only valid with the 'benchmark' command."
+      puts "    -v          Display more verbose (warning) messages."
+      puts "    -vv         Display more verbose (informational) messages."
+      puts
+      puts "Commands:"
+      puts "    benchmark   Benchmarks the parsing of the input path(s)."
+      puts "    parse       Parses the input path(s)."
+      puts "    test        Runs the specified unit tests, all are selected by default."
+      puts "    xml         Parses the input path(s) and displays them as XML."
+    end
+  end
+end

data/lib/nasl/command.rb

@@ -0,0 +1,96 @@
+################################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+module Nasl
+  class Command
+    def self.initialize!
+      Dir.glob(Nasl.lib + 'nasl/commands/*.rb').each { |f| load(f) }
+    end
+
+    def self.all
+      (@_all ||= [])
+    end
+
+    def self.inherited(cls)
+      all << cls
+    end
+
+    def self.find(cmd)
+      all.each do |cls|
+        return cls if cls.binding == cmd
+      end
+
+      nil
+    end
+
+    def self.banner(title, width=80)
+      # Create center of banner.
+      middle = "[ #{title} ]"
+
+      # Make sure width is a float.
+      width = width.to_f
+
+      # Create bars on either side.
+      leftover = (width - middle.length) / 2
+      left = '-' * leftover.floor
+      right = '-' * leftover.ceil
+
+      left + middle + right
+    end
+
+    def self.run(cfg, args)
+      # Separate plugins and libraries from the rest of the arguments.
+      paths = args.select { |arg| arg =~ /(\/|\.(inc|nasl))$/ }
+      args -= paths
+
+      # If we have no paths to process, there's a problem. Special purpose
+      # commands that don't require files to be declared should override this
+      # method.
+      if paths.empty?
+        puts "No directories (/), libraries (.inc), or plugins (.nasl) were specified."
+        exit 1
+      end
+
+      # Collect all the paths together, recursively.
+      dirents = []
+      paths.each do |path|
+        Pathname.new(path).find do |dirent|
+          if dirent.file? && dirent.extname =~ /inc|nasl/
+            dirents << dirent
+          end
+        end
+      end
+
+      # If the command is capable of handling all the paths at once, send them
+      # in a group, otherwise send them individually.
+      if self.respond_to? :analyze_all then
+        analyze_all(cfg, dirents, args)
+      else
+        dirents.each { |d| analyze(cfg, d, args) }
+      end
+    end
+  end
+end

data/lib/nasl/commands/benchmark.rb

@@ -0,0 +1,55 @@
+###############################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+require 'benchmark'
+
+module Nasl
+  class CommandBenchmark < Command
+    def self.binding
+      'benchmark'
+    end
+
+    def self.analyze(cfg, path, args)
+      puts banner(path.basename)
+
+      Benchmark.bmbm do |b|
+        # Read in the file outside of the benchmark, to avoid contaminating it
+        # with filesystem operations.
+        contents = File.open(path, "rb").read
+
+        b.report("Tokenize") do
+          cfg[:iterations].times { Tokenizer.new(contents).get_all }
+        end
+
+        #b.report("Parse") do
+        #  cfg[:iterations].times { Parser.new.parse(contents) }
+        #end
+      end
+
+      puts banner(path.basename)
+    end
+  end
+end

data/lib/nasl/commands/parse.rb

@@ -0,0 +1,55 @@
+###############################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+require 'rainbow'
+
+module Nasl
+  class CommandParse < Command
+    def self.binding
+      'parse'
+    end
+
+    def self.analyze(cfg, path, args)
+      begin
+        contents = File.open(path, "rb").read
+      rescue
+        puts '[' + 'VOID'.color(:magenta) + "] #{path}"
+        return
+      end
+
+      begin
+        Parser.new.parse(contents, path)
+      rescue Exception => e
+        puts '[' + 'FAIL'.color(:red) + "] #{path}"
+        puts e.message
+        puts e.backtrace
+        return
+      end
+
+      puts '[' + 'PASS'.color(:green) + "] #{path}"
+    end
+  end
+end

data/lib/nasl/commands/test.rb

@@ -0,0 +1,37 @@
+################################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+module Nasl
+  class CommandTest < Command
+    def self.binding
+      'test'
+    end
+
+    def self.run(cfg, args)
+      Test.initialize!(args)
+    end
+  end
+end

data/lib/nasl/commands/tokenize.rb

@@ -0,0 +1,46 @@
+###############################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+module Nasl
+  class CommandTokenize < Command
+    def self.binding
+      'tokenize'
+    end
+
+    def self.analyze(cfg, path, args)
+      contents = File.open(path, "rb").read
+
+      begin
+        Tokenizer.new(contents).get_tokens
+      rescue TokenException => e
+        puts "The tokenizer raised the following exceptions when processing #{path}:"
+        puts e.message
+        puts e.backtrace
+        puts
+      end
+    end
+  end
+end

data/lib/nasl/commands/xml.rb

@@ -0,0 +1,41 @@
+###############################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+module Nasl
+  class CommandXml < Command
+    def self.binding
+      'xml'
+    end
+
+    def self.analyze(cfg, path, args)
+      contents = File.open(path, "rb").read
+
+      puts banner(path.basename)
+      puts Parser.new.parse(contents).to_s
+      puts banner(path.basename)
+    end
+  end
+end

data/lib/nasl/context.rb

@@ -0,0 +1,102 @@
+###############################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+require 'rainbow'
+
+module Nasl
+  class Context
+    def initialize(code, path)
+      @code = code
+      @path = path
+
+      # Find all of the newlines in the source code.
+      i = 0
+      @newlines = @code.split(/\n/).map do |nl|
+        i += 1 + nl.length
+      end
+
+      # Treat the start and end of the file as a newlines to simplify the bol
+      # and eol functions.
+      @newlines.unshift(0)
+      @newlines.push(@code.length)
+
+      # Storing the list of newlines in descending order makes the row and
+      # column code nicer.
+      @newlines.reverse!
+    end
+
+    def bol(point)
+      @newlines.find { |nl| nl <= point }
+    end
+
+    def eol(point)
+      @code.index(/\n/, point) || @code.length
+    end
+
+    def col(point)
+      # Columns use base zero indexing.
+      point - bol(point)
+    end
+
+    def row(point)
+      # Rows use base one indexing.
+      @newlines.length - @newlines.index { |nl| nl <= point }
+    end
+
+    def context(inner, outer=nil, header=true, color=true)
+      # If no outer region was provided, we will assume that the desired outer
+      # is from the beginning of the line that the inner region starts on to the
+      # end of the line that the inner region finishes on.
+      outer = bol(inner.begin)..eol(inner.end) if outer.nil?
+
+      ctx = ""
+      point = inner.begin
+
+      # Create the location header.
+      ctx << "Context for row #{row(point)}, column #{col(point)} in file #@path:\n" if header
+
+      # Create the text to the left of the region. The only case where there is
+      # no text to the left is at the start of the program.
+      if outer.begin != inner.begin
+        line = @code[outer.begin..inner.begin - 1]
+        line = line.color(:green) if color
+        ctx << line
+      end
+
+      # Create the text in the region.
+      line = @code[inner.begin..inner.end - 1]
+      line = line.color(:red) if color
+      ctx << line
+
+      # Create the text to the right of the region.
+      line = @code[inner.end..outer.end].chomp
+      line = line.color(:green) if color
+      ctx << line
+
+      ctx << "\n"
+    end
+  end
+end