The Software Concordance: Using a Uniform Document Model to Integrate Program Analysis and Hypermedia

  • Authors:
  • Satish Chandra Gupta;Tien Nhut Nguyen;Ethan V. Munson

  • Affiliations:
  • -;-;-

  • Venue:
  • APSEC '03 Proceedings of the Tenth Asia-Pacific Software Engineering Conference Software Engineering Conference
  • Year:
  • 2003

Quantified Score

Hi-index 0.00

Visualization

Abstract

Since the source code is only one of many types of documentsthat must be maintained as a software system evolves,modern software development could be improved by betterinteroperability between source code and other softwaredocuments. The Software Concordance is a prototype programmingenvironment that uses hypermedia services anda uniform document model to achieve this interoperability.The Software Concordance editor allows developers to enhancetheir inline documentation with multimedia objectsand hyperlinks, while still supporting advanced programanalysis including lexing, parsing and type checking.This paper motivates the need for environments likethe Software Concordance, describes the design and implementationof its program editor, and discusses lessonslearned while creating it. The system is based on a uniform,Web compatible document model for both program sourcecode and non-program software documents and a correspondingAPI. Important technical problems addressed bythis research include creating a persistent representationof program lexemes that the analysis suite considers tobe ephemeral (such as keywords), providing a simple incrementalparsing system, and embedding multimedia insource code without disrupting program analysis. Basedon insight gained in the process of implementing the documentAPI, a new approach to the design of a more suitableprogram analysis infrastructure is suggested.