flowchart

컴퓨터 언어(C, Java, Python, JavaScript 지원)의 소스코드를 시각적인 플로우차트(Flowchart)로 변환하고 그리기 위한 자바스크립트 모듈 라이브러리 프로젝트입니다.

빌드 없이 바로 사용하려면 위 링크에서 파일을 직접 다운로드하세요.


1. 아키텍처 및 폴더 구조

flowchart/
├── dist/                        # 빌드된 통합 배포본 (git 추적 포함)
│   ├── flowchart.js             # ESM 배포 파일 (import 방식)
│   └── flowchart.umd.cjs        # UMD 배포 파일 (<script> 태그 방식)
│
├── src/                         # 라이브러리 소스 코드
│   ├── index.js                 # 통합 엔트리 포인트 (외부 노출 API)
│   │
│   ├── core/                    # 시각화 및 그리드 배치 엔진 (언어 무관)
│   │   ├── LayoutEngine.js      # 노드 그리드 좌표(x, y) 계산 엔진
│   │   └── CanvasRenderer.js    # HTML5 Canvas 렌더링 및 인터랙션 처리
│   │
│   └── parsers/                 # 언어별 파서 디렉토리
│       ├── BaseParser.js        # 공통 파서 추상 클래스 (parse / format 인터페이스)
│       ├── CParser.js           # C 언어 구문 분석 및 포매터
│       ├── JavaParser.js        # Java 언어 구문 분석 및 포매터
│       ├── JavaScriptParser.js  # JavaScript 구문 분석 및 포매터
│       └── PythonParser.js      # Python 구문 분석 및 포매터
│
├── test-app/                    # 모듈 작동 여부를 직접 확인하기 위한 데모 웹앱
│   ├── index.html               # 메인 테스트 UI (실시간 코드 입력 → 차트 출력)
│   ├── main.js                  # 테스트 앱 진입점 (단축키·상태 관리 포함)
│   ├── example-esm.html         # ESM 방식 연동 예제 페이지
│   ├── example-umd.html         # UMD 방식 연동 예제 페이지
│   └── codes/                   # 언어별 예제 소스코드 파일 (C / Java / JavaScript / Python)
│       ├── C/
│       ├── Java/
│       ├── JavaScript/
│       └── Python/
│
├── package.json                 # 프로젝트 메타 및 빌드 스크립트 (Vite)
└── vite.config.js               # Vite 라이브러리 모드 빌드 설정

2. 타 프로젝트에서의 연동 방법

빠른 시작: 파일 다운로드 (빌드 불필요)

파일 용도 다운로드
flowchart.js ESM 방식 (React, Vue, Vite 등 모던 환경) 다운로드
flowchart.umd.cjs UMD 방식 (<script> 태그 직접 로드) 다운로드

방법 A. ESM (ES Modules) 방식 — React, Vue, Vite 등 모던 개발 환경

import { drawFlowchart } from './path/to/dist/flowchart.js';

const code = `
if (a == 1) {
  print(a);
} else {
  print(b);
}
`;
const canvas = document.getElementById('myCanvas');

// 지원 언어: 'C' | 'Java' | 'JavaScript' | 'Python'
drawFlowchart(code, 'C', canvas);

방법 B. UMD 방식 — 전통적인 브라우저 <script> 태그 환경

<!DOCTYPE html>
<html lang="ko">
<head>
  <meta charset="UTF-8">
  <title>Flowchart Test</title>
</head>
<body>
  <canvas id="myCanvas"></canvas>

  <!-- 통합 UMD 모듈 로드 (글로벌 Flowchart 객체 노출) -->
  <script src="./path/to/dist/flowchart.umd.cjs"></script>
  <script>
    const code = `
for (i = 0; i < 5; i++) {
  print(i);
}
`;
    const canvas = document.getElementById('myCanvas');

    // 글로벌 네임스페이스 Flowchart 사용
    Flowchart.drawFlowchart(code, 'C', canvas);
  </script>
</body>
</html>

방법 C. 파싱과 렌더링 분리 제어 (고급)

플로우차트를 화면에 그리기 전 노드 좌표를 직접 가공하거나, 렌더러 속성을 세밀하게 초기화하고 싶을 때 각 서브 클래스를 개별로 사용합니다.

import { CParser, JavaParser, PythonParser, JavaScriptParser,
         LayoutEngine, CanvasRenderer } from './dist/flowchart.js';

// 1. 원하는 언어의 파서 인스턴스 생성
const parser = new CParser();       // 또는 new JavaParser(), new PythonParser(), new JavaScriptParser()

// 1-1. (선택) 소스코드를 표준 포맷으로 정렬
const formattedCode = parser.format(rawCode);

// 1-2. 코드 분석 → 플로우차트 노드 배열 획득
const rawNodes = parser.parse(formattedCode);

// 2. 레이아웃 엔진으로 그리드 좌표(x, y) 계산
const layoutEngine = new LayoutEngine();
const positionedNodes = layoutEngine.calculatePositions(rawNodes);

// 3. 렌더러 인스턴스 생성 및 초기 상태 설정
const renderer = new CanvasRenderer(canvas);
renderer.fontScale       = 0.9;   // 글자 크기 배율 (기본 0.81)
renderer.zoom            = 1.5;   // 초기 줌 배율   (기본 1.22)
renderer.arrowHeadSize   = 8;     // 화살촉 픽셀 크기 (기본 9)
renderer.colorMode       = true;  // 노드 유형별 컬러 테마 ON
renderer.darkMode        = false; // 다크모드 OFF
renderer.fullScreen      = false; // 꽉 찬 화면 자동 피팅 OFF
renderer.branchTextMode  = 0;     // 0: Yes/No/loop  1: Y/N  2: 없음
renderer.showCoordsOnHover = false; // 마우스 호버 시 (x,y) 툴팁 표시 OFF

// 4. 드로잉 실행 (config 옵션도 동시 설정 가능)
renderer.draw(positionedNodes, {
  blockWidth:  120,  // 노드 가로 픽셀 (기본 100)
  blockHeight:  60,  // 노드 세로 픽셀 (기본 50)
  margin:       40,  // 노드 간격     (기본 30)
  paddingLeft:  30,  // 캔버스 좌측 여백
  paddingTop:   10,  // 캔버스 상단 여백
});

3. 로컬 개발 및 테스트 실행

소스 코드를 직접 수정하고 실시간으로 확인하려면 로컬 개발 서버를 이용합니다.

① 의존성 패키지 설치

npm install

② 로컬 개발 서버 구동 (실시간 핫 리로드)

npm run dev

브라우저에서 http://localhost:5173/test-app/ 을 열면 데모 앱이 표시됩니다.
src/ 폴더 내 파일을 수정하면 브라우저가 자동으로 갱신됩니다.

③ 배포용 빌드

npm run build

dist/flowchart.js (ESM)와 dist/flowchart.umd.cjs (UMD) 파일이 생성됩니다.


3.5 마우스 드래그 및 설정 리모콘 (v0.8+)

뷰어 내에서의 직관적인 탐색과 미세 제어를 위해 다음 기능들이 탑재되어 있습니다.

  1. 캔버스 마우스 드래그 이동 (패닝)
    • 캔버스 영역 위에서 마우스 왼쪽 버튼을 클릭한 상태로 드래그하면 순서도를 상하좌우 모든 방향으로 자유롭게 이동시킬 수 있습니다.
    • 드래그 이동 중에는 마우스 커서가 grabbing 형태로 변경되며, 자동 피팅(fullScreen) 모드가 부드럽게 해제됩니다.
  2. 우상단 플로팅 설정 아이콘 그룹 (마우스 호버 시 노출)
    • 캔버스 영역 안으로 마우스가 진입하면 우상단에 두 개의 플로팅 아이콘이 희미하게 나타납니다.
      • 📋 클립보드 복사 아이콘: 클릭 시 현재 뷰어의 모든 세팅(줌, 폰트크기, 간격, 마진, 색상 모드 등)을 JSON 객체 텍스트로 클립보드에 즉시 복사합니다. 이 복사된 JSON 객체는 타 프로젝트나 코드의 drawFlowchart(code, lang, canvas, options) 호출 시 options 인자로 넘겨주면 동일한 뷰 상태로 간편하게 초기화할 수 있습니다.
      • ⚙️ 설정 아이콘: 클릭 시 캔버스 내부에 설정 조작 리모콘 패널이 오버랩됩니다.
  3. 고대비 반투명 설정 리모콘 패널
    • ⚙️ 아이콘 클릭 시 순서도 영역 전체를 가리지 않도록 반투명도(rgba(15, 15, 30, 0.35))와 블러 처리를 가미한 글라스모피즘 스타일 리모콘 패널이 오버랩됩니다.
    • 리모콘 내부에는 캔버스 물리 해상도 안에서 스크롤 없이 간편히 조작 가능하도록 오밀조밀하게 정렬된 15개의 설정 제어 그리드 버튼이 배치되어 있습니다. (글자 크기, 노드 간격, 화살표 크기, 줌 인/아웃, 화면 자동 맞춤, Yes 표기 전환, 컬러/다크모드 토글, 캔버스 자체 상하좌우 패딩 마진 조절 등)

4. 인터랙티브 제어 API

drawFlowchart() 호출 후 반환된 renderer 객체의 필드와 메서드를 통해 차트를 동적으로 조작할 수 있습니다.

const { renderer } = drawFlowchart(code, 'C', canvas);

// ── 렌더링 상태 필드 ─────────────────────────────────────────────────────────
renderer.zoom            = 1.5;    // 전체 줌 배율 (수동 변경 시 fullScreen 해제 권장)
renderer.fontScale       = 1.0;    // 글자 크기 전체 배율
renderer.arrowHeadSize   = 8;      // 화살촉 크기 (px)
renderer.branchTextMode  = 0;      // 0: Yes/No/loop, 1: Y/N/없음, 2: 전부 숨김
renderer.showBranchText  = true;   // branchTextMode 0/2 토글 단축 setter
renderer.colorMode       = true;   // 노드 타입별 컬러 테마 ON/OFF
renderer.darkMode        = true;   // 다크 배경 테마 ON/OFF
renderer.fullScreen      = true;   // true이면 zoom을 무시하고 캔버스에 자동 피팅
renderer.showCoordsOnHover = true; // 마우스 오버 시 노드 (x,y) 좌표 툴팁 표시
renderer.offsetX         = 0;      // 캔버스 전체 수평 오프셋 (px)
renderer.offsetY         = 0;      // 캔버스 전체 수직 오프셋 (px)

// ── config 객체 (draw() 이후에도 직접 수정 가능) ─────────────────────────────
renderer.config.margin      = 40;  // 노드 간격 (px), 변경 후 resizeCanvas() 필요
renderer.config.blockWidth  = 120; // 노드 가로 크기 (px)
renderer.config.blockHeight = 60;  // 노드 세로 크기 (px)

// ── 메서드 ──────────────────────────────────────────────────────────────────
renderer._render();       // 현재 상태로 전체 화면을 즉시 다시 그립니다.
renderer.resizeCanvas();  // margin/blockWidth 변경 후 캔버스 물리 크기를 재계산합니다.
renderer.fitToCanvas();   // 현재 캔버스 크기에 맞게 zoom과 offset을 자동 계산합니다.
renderer.download('flowchart.png'); // 현재 차트를 PNG 파일로 다운로드합니다.

실전 사용 예시

const { renderer } = drawFlowchart(code, 'Python', canvas);

// 글자 10% 확대 후 즉시 반영
renderer.fontScale *= 1.1;
renderer._render();

// 노드 간격을 넓히고 캔버스 물리 크기 재계산
renderer.config.margin = 50;
renderer.resizeCanvas();
renderer._render();

// 다크 + 컬러 모드 동시 활성화
renderer.darkMode  = true;
renderer.colorMode = true;
renderer._render();

// 꽉 찬 화면으로 자동 피팅 (zoom/offset 자동 계산)
renderer.fullScreen = true;
renderer.fitToCanvas();

// PNG 다운로드
renderer.download('my_flowchart.png');

5. 키보드 단축키 (테스트 앱 기준)

이 단축키들은 test-app/main.js에서 구현되어 있으며, 라이브러리 자체에는 포함되지 않습니다.
자체 앱에 적용하려면 해당 키 처리 코드를 참고하여 직접 구현하세요.

단축키 기능 세부 동작
Alt + Shift + F 소스코드 자동 정렬 parser.format(code) 호출
+ / - 글자 크기 ±10% renderer.fontScale *= 1.1 / 0.9
[ / ] 노드 간격 ±5px renderer.config.margin ±= 5 → resizeCanvas()
< / > 화살촉 크기 ±1px renderer.arrowHeadSize ±= 1
_ 분기 텍스트 순환 branchTextMode 0 → 1 → 2 → 0 순환
= 자동 피팅 renderer.fullScreen = true → fitToCanvas()
* / / 줌인 / 줌아웃 renderer.zoom *= 1.1 / 0.9 (fullScreen 해제)
c 컬러 모드 토글 renderer.colorMode = !renderer.colorMode
d 다크 모드 토글 renderer.darkMode = !renderer.darkMode
x 호버 좌표 토글 renderer.showCoordsOnHover = !renderer.showCoordsOnHover
v 현재 세팅값 출력 Alert로 전체 상태값 표시
s 세팅값 저장 localStorage.setItem('flowchart_settings', ...)
l 세팅값 불러오기 localStorage.getItem('flowchart_settings')
b 세팅값 클립보드 복사 navigator.clipboard.writeText(JSON.stringify(...))
? 단축키 도움말 표시 오버레이 모달 토글

※ code-input 에디터에 포커스가 있을 때는 Alt+Shift+F 를 제외한 단축키가 동작하지 않습니다.


6. 기본 세팅값 (Default Settings)

{
  "zoom": 1.22,
  "fontScale": 0.81,
  "margin": 50,
  "arrowHeadSize": 9,
  "branchTextMode": 0,
  "showCoordsOnHover": false,
  "fullScreen": true,
  "colorMode": false,
  "darkMode": false
}