linguist/lib/linguist/heuristics.rb

module Linguist
  # A collection of simple heuristics that can be used to better analyze languages.
  class Heuristics
    ACTIVE = true

    # Public: Given an array of String language names,
    # apply heuristics against the given data and return an array
    # of matching languages, or nil.
    #
    # name      - Name of the file the data is coming from.
    # data      - Array of tokens or String data to analyze.
    # languages - Array of language name Strings to restrict to.
    #
    # Returns an array of Languages or []
    def self.find_by_heuristics(name, data, languages)
      if active?
        result = []

        if languages.all? { |l| ["Perl", "Prolog"].include?(l) }
          result = disambiguate_pl(data)
        end
        if languages.all? { |l| ["ECL", "Prolog"].include?(l) }
          result = disambiguate_ecl(data)
        end
        if languages.all? { |l| ["IDL", "Prolog"].include?(l) }
          result = disambiguate_pro(data)
        end
        if languages.all? { |l| ["Common Lisp", "OpenCL"].include?(l) }
          result = disambiguate_cl(data)
        end
        if languages.all? { |l| ["Hack", "PHP"].include?(l) }
          result = disambiguate_hack(data)
        end
        if languages.all? { |l| ["Scala", "SuperCollider"].include?(l) }
          result = disambiguate_sc(data)
        end
        if languages.all? { |l| ["AsciiDoc", "AGS Script"].include?(l) }
          result = disambiguate_asc(data)
        end
        if languages.all? { |l| ["FORTRAN", "Forth"].include?(l) }
          result = disambiguate_f(data)
        end
        if name.end_with? ".tst" and languages.all? { |l| ["GAP", "Scilab"].include?(l) }
          result = disambiguate_tst(data)
        end
        return result
      end
    end

    # .h extensions are ambiguous between C, C++, and Objective-C.
    # We want to shortcut look for Objective-C _and_ now C++ too!
    #
    # Returns an array of Languages or []
    def self.disambiguate_c(data)
      matches = []
      if data.include?("@interface")
        matches << Language["Objective-C"]
      elsif data.include?("#include <cstdint>")
        matches << Language["C++"]
      end
      matches
    end

    def self.disambiguate_pl(data)
      matches = []
      if data.include?("use strict")
        matches << Language["Perl"]
      elsif data.include?(":-")
        matches << Language["Prolog"]
      end
      matches
    end

    def self.disambiguate_ecl(data)
      matches = []
      if data.include?(":-")
        matches << Language["Prolog"]
      elsif data.include?(":=")
        matches << Language["ECL"]
      end
      matches
    end

    def self.disambiguate_pro(data)
      matches = []
      if (data.include?(":-"))
        matches << Language["Prolog"]
      else
        matches << Language["IDL"]
      end
      matches
    end

    def self.disambiguate_ts(data)
      matches = []
      if (data.include?("</translation>"))
        matches << Language["XML"]
      else
        matches << Language["TypeScript"]
      end
      matches
    end

    def self.disambiguate_tst(data)
      matches = []
      if (data.include?("gap> "))
        matches << Language["GAP"]
      else
        matches << Language["Scilab"]
      end
      matches
    end

    def self.disambiguate_cl(data)
      matches = []
      if data.include?("(defun ")
        matches << Language["Common Lisp"]
      elsif /\/\* |\/\/ |^\}/.match(data)
        matches << Language["OpenCL"]
      end
      matches
    end

    def self.disambiguate_r(data)
      matches = []
      matches << Language["Rebol"] if /\bRebol\b/i.match(data)
      matches << Language["R"] if data.include?("<-")
      matches
    end

    def self.disambiguate_hack(data)
      matches = []
      if data.include?("<?hh")
        matches << Language["Hack"]
      elsif /<?[^h]/.match(data)
        matches << Language["PHP"]
      end
      matches
    end

    def self.disambiguate_sc(data)
      matches = []
      if (/\^(this|super)\./.match(data) || /^\s*(\+|\*)\s*\w+\s*{/.match(data) || /^\s*~\w+\s*=\./.match(data))
        matches << Language["SuperCollider"]
      end
      if (/^\s*import (scala|java)\./.match(data) || /^\s*val\s+\w+\s*=/.match(data) || /^\s*class\b/.match(data))
        matches << Language["Scala"]
      end
      matches
    end

    def self.disambiguate_asc(data)
      matches = []
      matches << Language["AsciiDoc"] if /^=+(\s|\n)/.match(data)
      matches
    end

    def self.disambiguate_f(data)
      matches = []
      if /^: /.match(data)
        matches << Language["Forth"]
      elsif /^([c*][^a-z]|      subroutine\s)/i.match(data)
        matches << Language["FORTRAN"]
      end
      matches
    end

    def self.active?
      !!ACTIVE
    end
  end
end