gemini-cli/packages/core/src/agent/tool-display-utils.ts

/**
 * @license
 * Copyright 2026 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */

import * as Diff from 'diff';
import type {
  ToolInvocation,
  ToolResult,
  ToolResultDisplay,
} from '../tools/tools.js';
import type { ToolDisplay, DisplayContent, DisplayDiff } from './types.js';

/**
 * Populates a ToolDisplay object from a tool invocation and its result.
 * This serves as a centralized bridge during the migration to tool-controlled display.
 */
export function populateToolDisplay({
  name,
  invocation,
  resultDisplay,
  displayName,
  display: prevDisplay,
}: {
  name: string;
  invocation?: ToolInvocation<object, ToolResult>;
  resultDisplay?: ToolResultDisplay;
  displayName?: string;
  display?: ToolDisplay;
}): ToolDisplay {
  const display: ToolDisplay = {
    name: displayName || name,
    description: invocation?.getDescription?.(),
    ...prevDisplay,
  };

  if (resultDisplay !== undefined && display.result === undefined) {
    display.result = toolResultDisplayToDisplayContent(resultDisplay);
  }

  return display;
}

/**
 * Converts a legacy ToolResultDisplay into the new DisplayContent format.
 */
export function toolResultDisplayToDisplayContent(
  resultDisplay: ToolResultDisplay,
): DisplayContent {
  if (typeof resultDisplay === 'string') {
    return { type: 'text', text: resultDisplay };
  }

  // Handle FileDiff -> DisplayDiff
  if (
    typeof resultDisplay === 'object' &&
    resultDisplay !== null &&
    'fileDiff' in resultDisplay &&
    'newContent' in resultDisplay
  ) {
    return {
      type: 'diff',
      path: resultDisplay.filePath || resultDisplay.fileName,
      beforeText: resultDisplay.originalContent ?? '',
      afterText: resultDisplay.newContent,
    };
  }

  // Fallback for other structured types (LsTool, GrepTool, etc.)
  // These will be fully migrated in Step 5.
  return {
    type: 'text',
    text: JSON.stringify(resultDisplay),
  };
}

/**
 * Renders a universal diff string from a DisplayDiff object.
 */
export function renderDisplayDiff(diff: DisplayDiff): string {
  return Diff.createPatch(
    diff.path || 'file',
    diff.beforeText,
    diff.afterText,
    'Original',
    'Modified',
    { context: 3 },
  );
}

/**
 * Converts a DisplayContent object into a string representation.
 * Useful for fallback displays or non-interactive environments.
 */
export function displayContentToString(
  display: DisplayContent | undefined | null,
): string | undefined {
  if (!display) {
    return undefined;
  }
  if (display.type === 'text') {
    return display.text;
  }
  if (display.type === 'diff') {
    return renderDisplayDiff(display);
  }
  return JSON.stringify(display);
}