The cl-moss Reference Manual

Table of Contents

The cl-moss Reference Manual

This is the cl-moss Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:33:41 2020 GMT+0.

1 Introduction

CL-MOSS

About

This is a Common Lisp utility for submitting code to Stanford's MOSS (Measure Of Software Similarity) software similarity detection system. It allows submitting multiple source code files in order to generate a similarity report. The MOSS system only runs on Stanford's servers - you cannot run your own instance. Hence the need for a submission script. This one is mostly a Common Lisp rewrite of a PHP script written by Philipp Helo Rehs (available here).

Supported Languages

Currently supported languages are: C, C++, Java, ML, Pascal, Ada, Lisp, Scheme, Haskell, Fortran, ASCII, VHDL, Perl, Matlab, Python, MIPS assembly, Prolog, Spice, VB, C#, Modula2, a8086 assembly, JavaScript, PLSQL and Verilog

Installation

CL-MOSS is ASDF-based. The simplest way to install it is via Quicklisp by running:

CL-USER> (ql:quickload :cl-moss)

If you have a CL-MOSS repo cloned somewhere (e.g. for hacking), you can also make Quicklisp aware of it, e.g. by creating a symlink to it in your local-projects directory and then run:

CL-USER> (ql:quickload :cl-moss)

Example Usage

Below is a sample usage session:

CL-MOSS> (defparameter *moss* (moss-initialize "<user-id>"))
CL-MOSS> (set-language *moss* :lisp) ; string value is also fine
CL-MOSS> (add-base-file *moss* "project/example.lisp")
CL-MOSS> (add-by-wildcard *moss* "project/src/*.lisp")
CL-MOSS> (set-comment-string *moss* "Let's analyze some code similarities!")
CL-MOSS> (send *moss*)
-> "http://moss.stanford.edu/results/<submission-id>"

Last step should yield a URL where you can view the results of the analysis of your submitted files.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-moss

Author

Wojciech S. Gac <wojciech.s.gac@gmail.com>

License

GPLv3

Description

Common Lisp submission mechanism for Stanford’s MOSS system

Dependency

usocket

Source

cl-moss.asd (file)

Components

• package.lisp (file)
• util.lisp (file)
• cl-moss.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-moss.asd

Location

cl-moss.asd

Systems

cl-moss (system)

3.1.2 cl-moss/package.lisp

Parent

cl-moss (system)

Location

package.lisp

Packages

cl-moss

3.1.3 cl-moss/util.lisp

Dependency

package.lisp (file)

Parent

cl-moss (system)

Location

util.lisp

Internal Definitions

make-keyword (function)

3.1.4 cl-moss/cl-moss.lisp

Dependency

util.lisp (file)

Parent

cl-moss (system)

Location

cl-moss.lisp

Internal Definitions

• *allowed-languages* (special variable)
• *default-options* (special variable)
• *server-port* (special variable)
• *server-url* (special variable)
• add-base-file (method)
• add-by-wildcard (method)
• add-file (method)
• get-option-value (function)
• moss (class)
• moss-base-files (method)
• (setf moss-base-files) (method)
• moss-files (method)
• (setf moss-files) (method)
• moss-initialize (function)
• moss-options (method)
• (setf moss-options) (method)
• moss-port (method)
• (setf moss-port) (method)
• moss-server (method)
• (setf moss-server) (method)
• moss-user-id (method)
• (setf moss-user-id) (method)
• send (method)
• set-comment-string (method)
• set-directory-mode (method)
• set-experimental-server (method)
• set-ignore-limit (method)
• set-language (method)
• set-result-limit (method)
• upload-file (function)

4 Packages

Packages are listed by definition order.

4.1 cl-moss

Source

package.lisp (file)

Use List

common-lisp

Internal Definitions

• *allowed-languages* (special variable)
• *default-options* (special variable)
• *server-port* (special variable)
• *server-url* (special variable)
• add-base-file (generic function)
• add-base-file (method)
• add-by-wildcard (generic function)
• add-by-wildcard (method)
• add-file (generic function)
• add-file (method)
• get-option-value (function)
• make-keyword (function)
• moss (class)
• moss-base-files (generic function)
• moss-base-files (method)
• (setf moss-base-files) (method)
• (setf moss-base-files) (generic function)
• moss-files (generic function)
• moss-files (method)
• (setf moss-files) (method)
• (setf moss-files) (generic function)
• moss-initialize (function)
• moss-options (generic function)
• moss-options (method)
• (setf moss-options) (method)
• (setf moss-options) (generic function)
• moss-port (generic function)
• moss-port (method)
• (setf moss-port) (method)
• (setf moss-port) (generic function)
• moss-server (generic function)
• moss-server (method)
• (setf moss-server) (method)
• (setf moss-server) (generic function)
• moss-user-id (generic function)
• moss-user-id (method)
• (setf moss-user-id) (method)
• (setf moss-user-id) (generic function)
• send (generic function)
• send (method)
• set-comment-string (generic function)
• set-comment-string (method)
• set-directory-mode (generic function)
• set-directory-mode (method)
• set-experimental-server (generic function)
• set-experimental-server (method)
• set-ignore-limit (generic function)
• set-ignore-limit (method)
• set-language (generic function)
• set-language (method)
• set-result-limit (generic function)
• set-result-limit (method)
• upload-file (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Internal definitions

5.1.1 Special variables

Special Variable: *allowed-languages*

Package

cl-moss

Source

cl-moss.lisp (file)

Special Variable: *default-options*

Package

cl-moss

Source

cl-moss.lisp (file)

Special Variable: *server-port*

Package

cl-moss

Source

cl-moss.lisp (file)

Special Variable: *server-url*

Package

cl-moss

Source

cl-moss.lisp (file)

5.1.2 Functions

Function: get-option-value OPTION-ALIST OPTION

Package

cl-moss

Source

cl-moss.lisp (file)

Function: make-keyword X

Package

cl-moss

Source

util.lisp (file)

Function: moss-initialize USER-ID &key SERVER PORT

Package

cl-moss

Source

cl-moss.lisp (file)

Function: upload-file SOCKET FILE LANG ID

Package

cl-moss

Source

cl-moss.lisp (file)

5.1.3 Generic functions

Generic Function: add-base-file MOSS FILE

Package

cl-moss

Methods

Method: add-base-file (MOSS moss) FILE

Source

cl-moss.lisp (file)

Generic Function: add-by-wildcard MOSS PATTERN

Package

cl-moss

Methods

Method: add-by-wildcard (MOSS moss) PATTERN

Source

cl-moss.lisp (file)

Generic Function: add-file MOSS FILE

Package

cl-moss

Methods

Method: add-file (MOSS moss) FILE

Source

cl-moss.lisp (file)

Generic Function: moss-base-files OBJECT

Generic Function: (setf moss-base-files) NEW-VALUE OBJECT

Package

cl-moss

Methods

Method: moss-base-files (MOSS moss)

automatically generated reader method

Source

cl-moss.lisp (file)

Method: (setf moss-base-files) NEW-VALUE (MOSS moss)

automatically generated writer method

Source

cl-moss.lisp (file)

Generic Function: moss-files OBJECT

Generic Function: (setf moss-files) NEW-VALUE OBJECT

Package

cl-moss

Methods

Method: moss-files (MOSS moss)

automatically generated reader method

Source

cl-moss.lisp (file)

Method: (setf moss-files) NEW-VALUE (MOSS moss)

automatically generated writer method

Source

cl-moss.lisp (file)

Generic Function: moss-options OBJECT

Generic Function: (setf moss-options) NEW-VALUE OBJECT

Package

cl-moss

Methods

Method: moss-options (MOSS moss)

automatically generated reader method

Source

cl-moss.lisp (file)

Method: (setf moss-options) NEW-VALUE (MOSS moss)

automatically generated writer method

Source

cl-moss.lisp (file)

Generic Function: moss-port OBJECT

Generic Function: (setf moss-port) NEW-VALUE OBJECT

Package

cl-moss

Methods

Method: moss-port (MOSS moss)

automatically generated reader method

Source

cl-moss.lisp (file)

Method: (setf moss-port) NEW-VALUE (MOSS moss)

automatically generated writer method

Source

cl-moss.lisp (file)

Generic Function: moss-server OBJECT

Generic Function: (setf moss-server) NEW-VALUE OBJECT

Package

cl-moss

Methods

Method: moss-server (MOSS moss)

automatically generated reader method

Source

cl-moss.lisp (file)

Method: (setf moss-server) NEW-VALUE (MOSS moss)

automatically generated writer method

Source

cl-moss.lisp (file)

Generic Function: moss-user-id OBJECT

Generic Function: (setf moss-user-id) NEW-VALUE OBJECT

Package

cl-moss

Methods

Method: moss-user-id (MOSS moss)

automatically generated reader method

Source

cl-moss.lisp (file)

Method: (setf moss-user-id) NEW-VALUE (MOSS moss)

automatically generated writer method

Source

cl-moss.lisp (file)

Generic Function: send MOSS

Package

cl-moss

Methods

Method: send (MOSS moss)

Source

cl-moss.lisp (file)

Generic Function: set-comment-string MOSS COMMENT

Package

cl-moss

Methods

Method: set-comment-string (MOSS moss) COMMENT

Source

cl-moss.lisp (file)

Generic Function: set-directory-mode MOSS BOOL

Package

cl-moss

Methods

Method: set-directory-mode (MOSS moss) BOOL

Source

cl-moss.lisp (file)

Generic Function: set-experimental-server MOSS BOOL

Package

cl-moss

Methods

Method: set-experimental-server (MOSS moss) BOOL

Source

cl-moss.lisp (file)

Generic Function: set-ignore-limit MOSS LIMIT

Package

cl-moss

Methods

Method: set-ignore-limit (MOSS moss) LIMIT

Source

cl-moss.lisp (file)

Generic Function: set-language MOSS LANGUAGE

Package

cl-moss

Methods

Method: set-language (MOSS moss) LANGUAGE

Source

cl-moss.lisp (file)

Generic Function: set-result-limit MOSS LIMIT

Package

cl-moss

Methods

Method: set-result-limit (MOSS moss) LIMIT

Source

cl-moss.lisp (file)

5.1.4 Classes

Class: moss ()

Package

cl-moss

Source

cl-moss.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• send (method)
• add-by-wildcard (method)
• add-file (method)
• add-base-file (method)
• set-experimental-server (method)
• set-result-limit (method)
• set-comment-string (method)
• set-ignore-limit (method)
• set-directory-mode (method)
• set-language (method)
• moss-base-files (method)
• moss-base-files (method)
• moss-files (method)
• moss-files (method)
• moss-user-id (method)
• moss-user-id (method)
• moss-port (method)
• moss-port (method)
• moss-server (method)
• moss-server (method)
• moss-options (method)
• moss-options (method)

Direct slots

Slot: options

Initargs

:options

Initform

cl-moss::*default-options*

Readers

moss-options (generic function)

Writers

(setf moss-options) (generic function)

Slot: server

Initargs

:server

Initform

cl-moss::*server-url*

Readers

moss-server (generic function)

Writers

(setf moss-server) (generic function)

Slot: port

Initargs

:port

Initform

cl-moss::*server-port*

Readers

moss-port (generic function)

Writers

(setf moss-port) (generic function)

Slot: user-id

Initargs

:user-id

Initform

(error "user id is required")

Readers

moss-user-id (generic function)

Writers

(setf moss-user-id) (generic function)

Slot: files

Initargs

:files

Readers

moss-files (generic function)

Writers

(setf moss-files) (generic function)

Slot: base-files

Initargs

:base-files

Readers

moss-base-files (generic function)

Writers

(setf moss-base-files) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types