Metrics about the usage of explicit and implicit self

Introduced classes

private class ASelfVisitor

nitc :: ASelfVisitor

private class SelfMetricsPhase

nitc :: SelfMetricsPhase

Redefined classes

redef class Sys

nitc :: self_metrics $ Sys

The main class of the program.

redef class ToolContext

nitc :: self_metrics $ ToolContext

Global context for tools

All class definitions

private class ASelfVisitor

nitc $ ASelfVisitor

private class SelfMetricsPhase

nitc $ SelfMetricsPhase

redef class Sys

nitc :: self_metrics $ Sys

The main class of the program.

redef class ToolContext

nitc :: self_metrics $ ToolContext

Global context for tools

Ancestors

module abstract_collection

core :: abstract_collection

Abstract collection classes and services.

module abstract_text

core :: abstract_text

Abstract class for manipulation of sequences of characters

module array

This module introduces the standard array structure.

module bitset

Services to handle BitSet

module bytes

Services for byte streams and arrays

module caching

serialization :: caching

Services for caching serialization engines

module circular_array

core :: circular_array

Efficient data structure to access both end of the sequence.

module codec_base

core :: codec_base

Base for codecs to use with streams

module codecs

Group module for all codec-related manipulations

module collection

core :: collection

This module define several collection classes.

module console

console :: console

Defines some ANSI Terminal Control Escape Sequences.

module core

Standard classes and methods used by default by Nit programs and libraries.

module counter

counter :: counter

Simple numerical statistical analysis and presentation

module csv

CSV document handling.

module digraph

graph :: digraph

Implementation of directed graphs, also called digraphs.

module engine_tools

serialization :: engine_tools

Advanced services for serialization engines

module environ

core :: environ

Access to the environment variables of the process

module error

Standard error-management infrastructure.

module exec

Invocation and management of operating system sub-processes.

module file

File manipulations (create, read, write, etc.)

module fixed_ints

core :: fixed_ints

Basic integers of fixed-precision

module fixed_ints_text

core :: fixed_ints_text

Text services to complement fixed_ints

module flat

All the array-based text representations

module gc

Access to the Nit internal garbage collection mechanism

module hash_collection

core :: hash_collection

Introduce HashMap and HashSet.

module ini

Read and write INI configuration files

module inspect

serialization :: inspect

Refine Serializable::inspect to show more useful information

module iso8859_1

core :: iso8859_1

Codec for ISO8859-1 I/O

module kernel

Most basic classes and methods.

module lexer

Lexer and its tokens.

module lexer_work

nitc :: lexer_work

Internal algorithm and data structures for the Nit lexer

module list

This module handle double linked lists

module loader

Loading of Nit source files

module location

nitc :: location

Nit source-file and locations in source-file

module math

Mathematical operations

module mdoc

Documentation of model entities

module meta

Simple user-defined meta-level to manipulate types of instances as object.

module mmodule

nitc :: mmodule

modules and module hierarchies in the metamodel

module model

Classes, types and properties

module model_base

nitc :: model_base

The abstract concept of model and related common things

module modelbuilder

nitc :: modelbuilder

module modelbuilder_base

nitc :: modelbuilder_base

Load nit source files and build the associated model

module more_collections

more_collections :: more_collections

Highly specific, but useful, collections-related classes.

module mpackage

nitc :: mpackage

Modelisation of a Nit package

module native

Native structures for text and bytes

module nitpm_shared

nitc :: nitpm_shared

Services related to the Nit package manager

module numeric

core :: numeric

Advanced services for Numeric types

module opts

Management of options on the command line

module ordered_tree

ordered_tree :: ordered_tree

Manipulation and presentation of ordered trees.

module parser

Parser.

module parser_nodes

nitc :: parser_nodes

AST nodes of the Nit language

module parser_prod

nitc :: parser_prod

Production AST nodes full definition.

module parser_work

nitc :: parser_work

Internal algorithm and data structures for the Nit parser

module phase

Phases of the processing of nit programs

module poset

Pre order sets and partial order set (ie hierarchies)

module protocol

core :: protocol

module queue

Queuing data structures and wrappers

module range

Module for range of discrete objects.

module re

Regular expression support for all services based on Pattern

module ropes

Tree-based representation of a String.

module serialization

serialization :: serialization

General serialization services

module serialization_core

serialization :: serialization_core

Abstract services to serialize Nit objects to different formats

module sorter

This module contains classes used to compare things and sorts arrays.

module stream

Input and output streams of characters

module string_search

core :: string_search

Basic string search, match and replace.

module tables

Module that interfaces the parsing tables.

module template

template :: template

Basic template system

module text

All the classes and methods related to the manipulation of text entities

module time

Management of time and dates

module toolcontext

nitc :: toolcontext

Common command-line tool infrastructure than handle options and error messages

module union_find

core :: union_find

union–find algorithm using an efficient disjoint-set data structure

module utf8

Codec for UTF-8 I/O

module version

nitc :: version

This file was generated by git-gen-version.sh

Parents

module metrics_base

nitc :: metrics_base

Helpers for various statistics tools.

Children

module metrics

nitc :: metrics

Various statistics about Nit models and programs

Descendants

module a_star-m

module api

Components required to build a web server about the nit model.

module api_metrics

nitc :: api_metrics

module nitmetrics

nitc :: nitmetrics

A program that collects various metrics on nit programs and libraries

module nitweb

Runs a webserver based on nitcorn that render things from model.

# Metrics about the usage of explicit and implicit self
module self_metrics

import metrics_base

redef class ToolContext
	var self_metrics_phase: Phase = new SelfMetricsPhase(self, null)
end

private class SelfMetricsPhase
	super Phase
	redef fun process_mainmodule(mainmodule, given_mmodules)
	do
		if not toolcontext.opt_self.value and not toolcontext.opt_all.value then return
		compute_self_metrics(toolcontext.modelbuilder)
	end
end

private class ASelfVisitor
	super Visitor
	var total: Int = 0
	var implicits: Int = 0

	redef fun visit(n)
	do
		if n isa ASelfExpr then
			self.total += 1
			if n isa AImplicitSelfExpr then
				self.implicits += 1
			end
		end
		n.visit_all(self)
	end
end

# Visit the AST and print metics about the usage of self.
fun compute_self_metrics(modelbuilder: ModelBuilder)
do
	print "--- Explicit vs. Implicit Self ---"
	# Visit all the source code to collect data
	var visitor = new ASelfVisitor
	for nmodule in modelbuilder.nmodules do
		for nclassdef in nmodule.n_classdefs do
			visitor.enter_visit(nclassdef)
		end
	end
	print "Total number of self: {visitor.total}"
	print "Total number of implicit self: {visitor.implicits} ({div(visitor.implicits*100,visitor.total)}%)"
end

src/metrics/self_metrics.nit:17,1--65,3